@aptly-as/types 2.2.9 → 2.3.0

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",

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";

package/models/app.d.ts

@@ -19,13 +19,20 @@ export interface AptlyAppSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>
     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/order.d.ts

@@ -2,10 +2,16 @@ 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'> {
     orderNumber: string;
@@ -30,8 +36,24 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
         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,13 +89,14 @@ 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>[];
     quantity: number;
     unitCost: number;
     unitVat?: number;
+    vat?: number;
     pricePipeline: AptlyOrderItemPricePipelineSchema<ID>[];
 }
 export type AptlyOrderItemPricePipeline = AptlyOrderItemPricePipelineSchema<string>;
@@ -84,6 +107,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/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-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.9",
+  "version": "2.3.0",
   "description": "Aptly types and enums",
   "type": "module",
   "main": "./index.js",