@aptly-as/types 2.2.10 → 2.3.1

package/core/redirect.d.ts

@@ -1,9 +1,12 @@
 export declare enum AptlyRedirectAction {
-    Sign = "sign"
+    Sign = "sign",
+    Payment = "payment"
 }
 export declare enum AptlyRedirectActionError {
     SignCancel = "signCancel",
-    SignError = "signError"
+    SignError = "signError",
+    Cancel = "cancel",
+    Error = "error"
 }
 export type AptlyRedirectOptions = {
     action: AptlyRedirectAction;

package/core/redirect.js

@@ -1,9 +1,12 @@
 export var AptlyRedirectAction;
 (function (AptlyRedirectAction) {
     AptlyRedirectAction["Sign"] = "sign";
+    AptlyRedirectAction["Payment"] = "payment";
 })(AptlyRedirectAction || (AptlyRedirectAction = {}));
 export var AptlyRedirectActionError;
 (function (AptlyRedirectActionError) {
     AptlyRedirectActionError["SignCancel"] = "signCancel";
     AptlyRedirectActionError["SignError"] = "signError";
+    AptlyRedirectActionError["Cancel"] = "cancel";
+    AptlyRedirectActionError["Error"] = "error";
 })(AptlyRedirectActionError || (AptlyRedirectActionError = {}));

package/core/scope.d.ts

@@ -6,14 +6,15 @@ export declare enum AptlyModules {
     Departments = "departments",
     OptionLabels = "optionLabels",
     Pages = "pages",
+    Payment = "payment",
     ProductsExtended = "productsExtended",
     Recommendations = "recommendations",
     Subcontractor = "subcontractor",
-    ThirdParty = "thirdParty",
     Sign = "sign",
     Support = "support",
     SupportComplaint = "supportComplaint",
     Testing = "testing",
+    ThirdParty = "thirdParty",
     UnitExtraOptions = "unitExtraOptions",
     UnitExtraFields = "unitExtraFields"
 }
@@ -41,6 +42,7 @@ export declare enum AptlyScopes {
     OrganizationMembers = "organizationMembers",
     OrganizationOptionLabels = "organizationOptionLabels",
     OrganizationOrders = "organizationOrders",
+    OrganizationPayment = "organizationPayment",
     OrganizationPages = "organizationPages",
     OrganizationProducts = "organizationProducts",
     OrganizationProductsExtended = "organizationProductsExtended",

package/core/scope.js

@@ -7,14 +7,15 @@ export var AptlyModules;
     AptlyModules["Departments"] = "departments";
     AptlyModules["OptionLabels"] = "optionLabels";
     AptlyModules["Pages"] = "pages";
+    AptlyModules["Payment"] = "payment";
     AptlyModules["ProductsExtended"] = "productsExtended";
     AptlyModules["Recommendations"] = "recommendations";
     AptlyModules["Subcontractor"] = "subcontractor";
-    AptlyModules["ThirdParty"] = "thirdParty";
     AptlyModules["Sign"] = "sign";
     AptlyModules["Support"] = "support";
     AptlyModules["SupportComplaint"] = "supportComplaint";
     AptlyModules["Testing"] = "testing";
+    AptlyModules["ThirdParty"] = "thirdParty";
     AptlyModules["UnitExtraOptions"] = "unitExtraOptions";
     AptlyModules["UnitExtraFields"] = "unitExtraFields";
 })(AptlyModules || (AptlyModules = {}));
@@ -43,6 +44,7 @@ export var AptlyScopes;
     AptlyScopes["OrganizationMembers"] = "organizationMembers";
     AptlyScopes["OrganizationOptionLabels"] = "organizationOptionLabels";
     AptlyScopes["OrganizationOrders"] = "organizationOrders";
+    AptlyScopes["OrganizationPayment"] = "organizationPayment";
     AptlyScopes["OrganizationPages"] = "organizationPages";
     AptlyScopes["OrganizationProducts"] = "organizationProducts";
     AptlyScopes["OrganizationProductsExtended"] = "organizationProductsExtended";

package/enums/index.d.ts

@@ -9,6 +9,7 @@ export declare enum AptlyOrderStatus {
     SignedByCustomer = "signedByCustomer",
     SignedByOrganization = "signedByOrganization",
     Signed = "signed",
+    Payment = "payment",
     FileReceived = "fileReceived",
     Completed = "completed",
     AllPeriodsSigned = "allPeriodsSigned",
@@ -110,3 +111,16 @@ export declare enum AptlyProjectStatus {
     Started = "started",
     Completed = "completed"
 }
+export declare enum AptlyOrganizationType {
+    Carpenter = "carpenter",
+    Contractor = "contractor",
+    Electrician = "electrician",
+    Plumber = "plumber"
+}
+export declare enum AptlyOrganizationStatus {
+    NewBusiness = 0,
+    Active = 1,
+    Inactive = 2,
+    Paused = 3,
+    Closed = 4
+}

package/enums/index.js

@@ -10,6 +10,7 @@ export var AptlyOrderStatus;
     AptlyOrderStatus["SignedByCustomer"] = "signedByCustomer";
     AptlyOrderStatus["SignedByOrganization"] = "signedByOrganization";
     AptlyOrderStatus["Signed"] = "signed";
+    AptlyOrderStatus["Payment"] = "payment";
     AptlyOrderStatus["FileReceived"] = "fileReceived";
     AptlyOrderStatus["Completed"] = "completed";
     AptlyOrderStatus["AllPeriodsSigned"] = "allPeriodsSigned";
@@ -127,3 +128,18 @@ export var AptlyProjectStatus;
     AptlyProjectStatus["Started"] = "started";
     AptlyProjectStatus["Completed"] = "completed";
 })(AptlyProjectStatus || (AptlyProjectStatus = {}));
+export var AptlyOrganizationType;
+(function (AptlyOrganizationType) {
+    AptlyOrganizationType["Carpenter"] = "carpenter";
+    AptlyOrganizationType["Contractor"] = "contractor";
+    AptlyOrganizationType["Electrician"] = "electrician";
+    AptlyOrganizationType["Plumber"] = "plumber";
+})(AptlyOrganizationType || (AptlyOrganizationType = {}));
+export var AptlyOrganizationStatus;
+(function (AptlyOrganizationStatus) {
+    AptlyOrganizationStatus[AptlyOrganizationStatus["NewBusiness"] = 0] = "NewBusiness";
+    AptlyOrganizationStatus[AptlyOrganizationStatus["Active"] = 1] = "Active";
+    AptlyOrganizationStatus[AptlyOrganizationStatus["Inactive"] = 2] = "Inactive";
+    AptlyOrganizationStatus[AptlyOrganizationStatus["Paused"] = 3] = "Paused";
+    AptlyOrganizationStatus[AptlyOrganizationStatus["Closed"] = 4] = "Closed";
+})(AptlyOrganizationStatus || (AptlyOrganizationStatus = {}));

package/models/app.d.ts

@@ -15,17 +15,25 @@ export interface AptlyAppSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>
     settings: AptlyAppSettingSchema<ID>[];
     webhooks: AptlyAppWebhookSchema<ID>[];
     menus: AptlyAppMenuSchema<ID, DATE>[];
+    cost?: number;
     implements: AptlyAppImplementation[];
     sign?: {
         orderUrl: string;
     };
+    payment?: {
+        orderUrl: string;
+        cancelUrl: string;
+        captureUrl: string;
+        voidUrl: string;
+    };
 }
 export interface AptlyAppSignMethod {
     value: string;
     label: string;
 }
 export declare enum AptlyAppImplementation {
-    Sign = "sign"
+    Sign = "sign",
+    Payment = "payment"
 }
 export declare enum AptlyAppImplementationSetting {
     SignCostPer = "costPerSign",

package/models/app.js

@@ -1,6 +1,7 @@
 export var AptlyAppImplementation;
 (function (AptlyAppImplementation) {
     AptlyAppImplementation["Sign"] = "sign";
+    AptlyAppImplementation["Payment"] = "payment";
 })(AptlyAppImplementation || (AptlyAppImplementation = {}));
 export var AptlyAppImplementationSetting;
 (function (AptlyAppImplementationSetting) {

package/models/module.d.ts

@@ -5,6 +5,7 @@ export interface AptlyModuleSchema<ID, DATE> {
     name: string;
     description: string;
     featuredWeight: number;
+    cost?: number;
     modules: AptlyModules[];
     createdAt: DATE;
     updatedAt: DATE;

package/models/order.d.ts

@@ -2,12 +2,18 @@ import { AptlyOrderStatus } from '../enums/index.js';
 import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyOrganizationAppConfigSchema, AptlyOrganizationSchema } from './organization.js';
+import { AptlyProductSchema } from './product.js';
 import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyUser, AptlyUserSchema } from './user.js';
+export declare enum AptlyOrderPaymentStatus {
+    Pending = "PENDING",
+    Authorized = "AUTHORIZED",
+    Captured = "CAPTURED"
+}
 export type AptlyOrder = AptlyOrderSchema<string, string>;
-export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
+export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name'> {
     orderNumber: string;
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
@@ -24,14 +30,31 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     totalVat?: number;
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
     signees?: AptlyOrderSigneeSchema<ID, DATE>[];
+    signedAt?: DATE | null;
     emailText?: string;
     approved?: {
         action?: AptlyOrderAction;
         user?: ID | AptlyUserSchema<ID, DATE>;
         at?: DATE;
     };
+    payment?: AptlyOrderPaymentSchema<DATE> | null;
     created: DATE;
 }
+export type AptlyOrderPayment = AptlyOrderPaymentSchema<string>;
+export interface AptlyOrderPaymentSchema<DATE> {
+    status: AptlyOrderPaymentStatus;
+    sessionId: string;
+    sessionAt: DATE | null;
+    url: string;
+    transactionId?: string;
+    transactionAt?: DATE;
+    captures: {
+        amount: number;
+        description?: string;
+    }[];
+    capturedAmount: number;
+    capturedAt?: DATE;
+}
 export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
 export interface AptlyOrderSigneeSchema<ID, DATE> {
     _id: ID;
@@ -67,7 +90,7 @@ export type AptlyOrderItem = AptlyOrderItemSchema<string, string>;
 export interface AptlyOrderItemSchema<ID, DATE> {
     _id: ID;
     text?: string;
-    product: ID;
+    product: ID | AptlyProductSchema<ID, DATE>;
     variant: ID;
     producer: ID;
     params: AptlyUnitItemParamSchema<ID, DATE>[];
@@ -85,6 +108,7 @@ export interface AptlyOrderItemPricePipelineSchema<ID> {
 }
 export declare enum AptlyOrderAction {
     Complete = "complete",
+    Payment = "payment",
     SignManually = "sign-manually",
     Sign = "sign"
 }

package/models/order.js

@@ -1,4 +1,10 @@
 import { AptlyAppImplementationSetting } from './app.js';
+export var AptlyOrderPaymentStatus;
+(function (AptlyOrderPaymentStatus) {
+    AptlyOrderPaymentStatus["Pending"] = "PENDING";
+    AptlyOrderPaymentStatus["Authorized"] = "AUTHORIZED";
+    AptlyOrderPaymentStatus["Captured"] = "CAPTURED";
+})(AptlyOrderPaymentStatus || (AptlyOrderPaymentStatus = {}));
 export var AptlyOrderSigneeType;
 (function (AptlyOrderSigneeType) {
     AptlyOrderSigneeType[AptlyOrderSigneeType["Unit"] = 0] = "Unit";
@@ -7,6 +13,7 @@ export var AptlyOrderSigneeType;
 export var AptlyOrderAction;
 (function (AptlyOrderAction) {
     AptlyOrderAction["Complete"] = "complete";
+    AptlyOrderAction["Payment"] = "payment";
     AptlyOrderAction["SignManually"] = "sign-manually";
     AptlyOrderAction["Sign"] = "sign";
 })(AptlyOrderAction || (AptlyOrderAction = {}));

package/models/organization.d.ts

@@ -1,5 +1,6 @@
 import { AptlyModules } from '../core/index.js';
 import { AptlyOrganizationRoles, AptlyAppScope, AptlySignageSchema } from '../core/index.js';
+import { AptlyOrganizationStatus, AptlyOrganizationType } from "../enums/index.js";
 import { AptlyModuleItemSchema } from './module.js';
 import { AptlyUserSchema } from './user.js';
 import { AptlyMediaSrc } from './media.js';
@@ -32,6 +33,8 @@ export interface AptlyOrganizationSchema<ID, DATE> extends AptlyBaseSchema<ID, D
     storageId?: string;
     producer?: ID | AptlyProducerSchema<ID, DATE> | null;
     installedModules: AptlyModuleItemSchema<ID, DATE>[];
+    status?: AptlyOrganizationStatus;
+    type?: AptlyOrganizationType[];
     created: DATE;
     fixedVariants?: boolean;
 }
@@ -65,6 +68,7 @@ export interface AptlyOrganizationInviteSchema<ID, DATE> {
     permissions?: AptlyOrganizationRoles[];
     projects?: ID[] | null;
     departments?: ID[] | null;
+    position?: AptlyOrganizationMemberPosition;
     claim: {
         email?: string;
         claimed: boolean;

package/models/project.d.ts

@@ -1,5 +1,6 @@
 import { AptlyProjectStatus } from '../enums/index.js';
 import { AptlyAlgorithm, AptlyAlgorithmPipeline, AptlyAlgorithmPipelineSchema, AptlyAlgorithmSchema } from './algorithm.js';
+import { AptlyAppSchema } from './app.js';
 import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyModules } from '../core/index.js';
 import { AptlyPeriod, AptlyPeriodSchema } from './period.js';
@@ -31,6 +32,7 @@ export interface AptlyProjectSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>,
     developer?: string;
     field?: string;
     address?: AptlyAddress;
+    paymentApp?: ID | AptlyAppSchema<ID, DATE> | null;
     created: DATE;
 }
 export type AptlyProjectPeriod = AptlyPeriod;

package/models/unit-email.d.ts

@@ -1,9 +1,9 @@
+import { AptlyBookingSchema } from './booking.js';
+import { AptlyBaseSchema } from './extends.js';
+import { AptlyInquirySchema } from './inquiry.js';
 import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyProjectSchema } from './project.js';
 import { AptlyUnitSchema } from './unit.js';
-import { AptlyInquirySchema } from './inquiry.js';
-import { AptlyBookingSchema } from './booking.js';
-import { AptlyBaseSchema } from './extends.js';
 export type AptlyUnitEmail = AptlyUnitEmailSchema<string, string>;
 export interface AptlyUnitEmailSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {
     type: AptlyUnitEmailType;

package/models/unit-template.d.ts

@@ -88,6 +88,7 @@ export interface AptlyUnitTemplateCategorySectionProductSchema<ID, DATE> {
     consequenceParam?: string;
     amount: number;
     unitCost?: number;
+    unitVat?: number;
     algorithm: ID | AptlyAlgorithmSchema<ID>;
     standard: boolean;
     standardVariant?: ID;

package/models/unit.d.ts

@@ -95,6 +95,7 @@ export interface AptlyUnitSelectedOptionSchema<ID, DATE> {
 export type AptlyUnitOptionItem = AptlyUnitOptionItemSchema<string, string>;
 export interface AptlyUnitOptionItemSchema<ID, DATE> extends AptlyUnitSelectedOptionSchema<ID, DATE> {
     unitCost: number;
+    unitVat?: number;
     pickRef?: ID;
 }
 export type AptlyUnitOptionExtraItem = AptlyUnitOptionExtraItemSchema<string, string>;

package/package.json

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