@aptly-as/types 2.9.1 → 3.0.0

package/core/scope.d.ts

@@ -5,6 +5,7 @@ export declare enum AptlyModules {
     Default = "default",
     Departments = "departments",
     Emails = "emails",
+    Offers = "offers",
     Options = "options",
     OptionLabels = "optionLabels",
     Pages = "pages",
@@ -63,6 +64,7 @@ export declare enum AptlyScopes {
     ProjectEmails = "projectEmails",
     ProjectInquiry = "projectInquiry",
     ProjectInquiryComplaint = "projectInquiryComplaint",
+    ProjectOffers = "projectOffers",
     ProjectOrders = "projectOrders",
     ProjectOptions = "projectOptions",
     ProjectPayment = "projectPayment",

package/core/scope.js

@@ -6,6 +6,7 @@ export var AptlyModules;
     AptlyModules["Default"] = "default";
     AptlyModules["Departments"] = "departments";
     AptlyModules["Emails"] = "emails";
+    AptlyModules["Offers"] = "offers";
     AptlyModules["Options"] = "options";
     AptlyModules["OptionLabels"] = "optionLabels";
     AptlyModules["Pages"] = "pages";
@@ -65,6 +66,7 @@ export var AptlyScopes;
     AptlyScopes["ProjectEmails"] = "projectEmails";
     AptlyScopes["ProjectInquiry"] = "projectInquiry";
     AptlyScopes["ProjectInquiryComplaint"] = "projectInquiryComplaint";
+    AptlyScopes["ProjectOffers"] = "projectOffers";
     AptlyScopes["ProjectOrders"] = "projectOrders";
     AptlyScopes["ProjectOptions"] = "projectOptions";
     AptlyScopes["ProjectPayment"] = "projectPayment";

package/core/webhook-event-data.d.ts

@@ -1,4 +1,4 @@
-import { AptlyDocumentSchema, AptlyOrderSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyUnitSchema } from '../models/index.js';
+import { AptlyDocumentSchema, AptlyOrderSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyProjectSchema, AptlyUnitSchema } from '../models/index.js';
 export declare namespace AptlyWebhookEventData {
     interface UnitWebhookSchema<ID, DATE> {
         unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name'>;
@@ -7,9 +7,14 @@ export declare namespace AptlyWebhookEventData {
         document: AptlyDocumentSchema<ID, DATE>;
         documentUrl: string;
     }
-    interface Payment<ID, DATE> {
+    type Payment = PaymentSchema<string, string>;
+    interface PaymentSchema<ID, DATE> {
+        unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name'>;
+        project: Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name'>;
         payment: AptlyPaymentSchema<ID, DATE>;
         order: Pick<AptlyOrderSchema<ID, DATE>, '_id' | 'orderNumber'>;
+        documentUrl?: string;
+        reportDocumentUrl?: string;
     }
     type NewUnitDocument = NewUnitDocumentSchema<string, string>;
     type NewUnitDocumentSchema<ID, DATE> = UnitWebhookSchema<ID, DATE> & UnitDocumentWebhookSchema<ID, DATE>;
@@ -19,6 +24,7 @@ export declare namespace AptlyWebhookEventData {
     }
     type Order = OrderSchema<string, string>;
     interface OrderSchema<ID, DATE> {
+        project: Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name'>;
         unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name' | 'shipping' | 'users'>;
         order: AptlyOrderSchema<ID, DATE>;
         receiptUrl?: string;

package/enums/fields.d.ts

@@ -1,4 +1,5 @@
 export declare enum AptlyFieldType {
+    Amount = "amount",
     Autocomplete = "autocomplete",
     AutocompleteSearch = "autocomplete-search",
     AutocompleteQuery = "autocomplete-query",

package/enums/fields.js

@@ -1,5 +1,6 @@
 export var AptlyFieldType;
 (function (AptlyFieldType) {
+    AptlyFieldType["Amount"] = "amount";
     AptlyFieldType["Autocomplete"] = "autocomplete";
     AptlyFieldType["AutocompleteSearch"] = "autocomplete-search";
     AptlyFieldType["AutocompleteQuery"] = "autocomplete-query";

package/enums/index.d.ts

@@ -113,7 +113,8 @@ export declare enum AptlyOrganizationType {
     Contractor = "contractor",
     Electrician = "electrician",
     Plumber = "plumber",
-    Producer = "producer"
+    Producer = "producer",
+    Integration = "integration"
 }
 export declare enum AptlyOrganizationStatus {
     NewBusiness = 0,
@@ -131,6 +132,7 @@ export declare enum AptlyEmailType {
     InviteAccepted = "invite-accepted",
     NewOwner = "new-owner",
     NoteReminder = "note-reminder",
+    Offer = "offer",
     OrderCreated = "order-created",
     OrderSign = "order-sign",
     OrderSignNotify = "order-sign-notify",

package/enums/index.js

@@ -131,6 +131,7 @@ export var AptlyOrganizationType;
     AptlyOrganizationType["Electrician"] = "electrician";
     AptlyOrganizationType["Plumber"] = "plumber";
     AptlyOrganizationType["Producer"] = "producer";
+    AptlyOrganizationType["Integration"] = "integration";
 })(AptlyOrganizationType || (AptlyOrganizationType = {}));
 export var AptlyOrganizationStatus;
 (function (AptlyOrganizationStatus) {
@@ -150,6 +151,7 @@ export var AptlyEmailType;
     AptlyEmailType["InviteAccepted"] = "invite-accepted";
     AptlyEmailType["NewOwner"] = "new-owner";
     AptlyEmailType["NoteReminder"] = "note-reminder";
+    AptlyEmailType["Offer"] = "offer";
     AptlyEmailType["OrderCreated"] = "order-created";
     AptlyEmailType["OrderSign"] = "order-sign";
     AptlyEmailType["OrderSignNotify"] = "order-sign-notify";

package/enums/standards.d.ts

@@ -2,6 +2,7 @@ export declare enum AptlyQuantityUnitCode {
     One = "C62",
     Piece = "H87",
     Meter = "MTR",
+    Kilometre = "KMT",
     SquareMeter = "MTK",
     Hour = "HUR",
     Day = "DAY"
@@ -17,6 +18,13 @@ export declare enum AptlyVatCategoryCode {
     StandardRate = "S",
     ExemptFromTax = "E"
 }
+export declare enum AptlyChargeReasonCode {
+    ShippingAndHandling = "SSA",
+    Labour = "LLA"
+}
+export declare enum AptlyAllowanceReasonCode {
+    Discount = 95
+}
 export declare enum AptlyCountryCode {
     Norway = "NO"
 }

package/enums/standards.js

@@ -3,6 +3,7 @@ export var AptlyQuantityUnitCode;
     AptlyQuantityUnitCode["One"] = "C62";
     AptlyQuantityUnitCode["Piece"] = "H87";
     AptlyQuantityUnitCode["Meter"] = "MTR";
+    AptlyQuantityUnitCode["Kilometre"] = "KMT";
     AptlyQuantityUnitCode["SquareMeter"] = "MTK";
     AptlyQuantityUnitCode["Hour"] = "HUR";
     AptlyQuantityUnitCode["Day"] = "DAY";
@@ -21,6 +22,15 @@ export var AptlyVatCategoryCode;
     AptlyVatCategoryCode["StandardRate"] = "S";
     AptlyVatCategoryCode["ExemptFromTax"] = "E";
 })(AptlyVatCategoryCode || (AptlyVatCategoryCode = {}));
+export var AptlyChargeReasonCode;
+(function (AptlyChargeReasonCode) {
+    AptlyChargeReasonCode["ShippingAndHandling"] = "SSA";
+    AptlyChargeReasonCode["Labour"] = "LLA";
+})(AptlyChargeReasonCode || (AptlyChargeReasonCode = {}));
+export var AptlyAllowanceReasonCode;
+(function (AptlyAllowanceReasonCode) {
+    AptlyAllowanceReasonCode[AptlyAllowanceReasonCode["Discount"] = 95] = "Discount";
+})(AptlyAllowanceReasonCode || (AptlyAllowanceReasonCode = {}));
 export var AptlyCountryCode;
 (function (AptlyCountryCode) {
     AptlyCountryCode["Norway"] = "NO";

package/error/error.js

@@ -21,7 +21,7 @@ export class AptlyError extends Error {
             id: 'unknown',
             status: response.status,
             message: response.statusText,
-            detail: body,
+            detail: typeof body === 'object' ? JSON.stringify(body) : body,
             link: response.url,
         });
     }

package/locales/en.json

@@ -4,7 +4,8 @@
       "C62": "",
       "H87": "PCS",
       "MTR": "Meter",
-      "MTK": "m2",
+      "KMT": "Kilometre",
+      "MTK": "m²",
       "HUR_one": "Hour",
       "HUR_other": "Hours",
       "DAY_one": "Day",

package/locales/nb.json

@@ -4,7 +4,8 @@
       "C62": "",
       "H87": "STK",
       "MTR": "Meter",
-      "MTK": "m2",
+      "KMT": "Kilometer",
+      "MTK": "m²",
       "HUR_one": "Time",
       "HUR_other": "Timer",
       "DAY_one": "Dag",

package/models/address.d.ts

@@ -0,0 +1,26 @@
+import { AptlyUnitSchema } from './unit.js';
+export interface AptlyAddress {
+    line1?: string;
+    line2?: string;
+    street?: string;
+    zip?: string;
+    city?: string;
+    county?: string;
+    country?: string;
+    location?: AptlyAddressLocation | null;
+}
+export interface AptlyAddressLocation {
+    type: 'Point';
+    coordinates: [lng: number, lat: number];
+}
+export interface AptlyAddressSearchQuery {
+    q?: string;
+    lat?: number;
+    lng?: number;
+}
+export type AptlySearchAddress = AptlySearchAddressSchema<string, string>;
+export interface AptlySearchAddressSchema<ID, DATE> extends Pick<AptlyUnitSchema<ID, DATE>, 'shipping' | 'houseNumber' | 'entrance' | 'countyNumber' | 'holdingNumber' | 'subHoldingNumber' | 'leaseNumber' | 'sectionNumber' | 'unitNumber'> {
+    _id: string;
+    name: string;
+    unitNumbers?: string[];
+}

package/models/address.js

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

package/models/algorithm.d.ts

@@ -1,14 +1,16 @@
+import { AptlyAllowanceReasonCode, AptlyChargeReasonCode, AptlyCurrency, AptlyQuantityUnitCode, AptlyTaxCategoryScheme, AptlyVatCategoryCode } from '../enums/index.js';
 export declare enum AptlyAlgorithmPipelineOperation {
     Base = "base",
     Add = "add",
     Subtract = "subtract",
     Multiply = "multiply",
-    Vat = "vat",
-    Fee = "fee"
+    Percent = "percent",
+    Fee = "fee",
+    Vat = "vat"
 }
 export declare enum AptlyAlgorithmPipelineApplyTo {
-    Base = "base",
     Root = "root",
+    Base = "base",
     PreviousStep = "previousStep"
 }
 export type AptlyAlgorithm = AptlyAlgorithmSchema<string>;
@@ -19,6 +21,8 @@ export interface AptlyAlgorithmSchema<ID> {
     reversed?: boolean;
     vat?: number;
     fee?: number;
+    feePercent?: number;
+    feeBasePercent?: number;
     organization?: ID;
     project?: ID;
 }
@@ -28,11 +32,63 @@ export interface AptlyAlgorithmPipelineSchema<ID> {
     label: string;
     operation: AptlyAlgorithmPipelineOperation;
     value: number;
+    valuePercent?: number;
     applyTo: AptlyAlgorithmPipelineApplyTo;
 }
+export interface AptlyAlgorithmPipelineDataItemSchema<ID> extends AptlyAlgorithmPipelineData {
+    _id: ID;
+}
 export interface AptlyAlgorithmPipelineData {
-    operation: AptlyAlgorithmPipelineOperation;
     label: string;
-    value: number;
+    operation: AptlyAlgorithmPipelineOperation;
+    value?: number;
+    baseAmount: number;
+    amount: number;
     diff: number;
 }
+export interface AptlyVatCategory {
+    id: AptlyVatCategoryCode;
+    percent: number;
+    taxScheme: AptlyTaxCategoryScheme;
+}
+export interface AptlyQuantity {
+    quantity?: number;
+    quantityUnitCode: AptlyQuantityUnitCode;
+}
+export interface AptlyExtensionQuantity extends AptlyQuantity {
+    invoicedQuantity?: number;
+    quantityUnitCode: AptlyQuantityUnitCode;
+}
+export interface AptlyExtensionAmount {
+    extensionAmount: number;
+    extensionVatAmount: number;
+    currency: AptlyCurrency;
+}
+export interface AptlyPrice {
+    amount: number;
+    allowance?: AptlyPriceAllowance;
+    baseQuantity: number;
+}
+export interface AptlyPriceAllowance {
+    amount: number;
+    baseAmount: number;
+}
+export interface AptlyExtensionPrice extends AptlyExtensionAmount {
+    invoicedQuantity?: number;
+    quantityUnitCode?: AptlyQuantityUnitCode;
+    price?: AptlyPrice;
+    currency: AptlyCurrency;
+}
+export interface AptlyAllowance {
+    amount?: number;
+    multiplier?: number;
+    incVAT?: boolean;
+}
+export type AptlyAllowanceCharge<CHARGE extends boolean> = AptlyAllowanceChargeSchema<string, CHARGE>;
+export interface AptlyAllowanceChargeSchema<ID, CHARGE extends boolean> extends AptlyAllowance {
+    _id: ID;
+    chargeIndicator: CHARGE;
+    code: CHARGE extends true ? AptlyChargeReasonCode : AptlyAllowanceReasonCode;
+    reason: string;
+    baseAmount?: number;
+}

package/models/algorithm.js

@@ -4,12 +4,13 @@ export var AptlyAlgorithmPipelineOperation;
     AptlyAlgorithmPipelineOperation["Add"] = "add";
     AptlyAlgorithmPipelineOperation["Subtract"] = "subtract";
     AptlyAlgorithmPipelineOperation["Multiply"] = "multiply";
-    AptlyAlgorithmPipelineOperation["Vat"] = "vat";
+    AptlyAlgorithmPipelineOperation["Percent"] = "percent";
     AptlyAlgorithmPipelineOperation["Fee"] = "fee";
+    AptlyAlgorithmPipelineOperation["Vat"] = "vat";
 })(AptlyAlgorithmPipelineOperation || (AptlyAlgorithmPipelineOperation = {}));
 export var AptlyAlgorithmPipelineApplyTo;
 (function (AptlyAlgorithmPipelineApplyTo) {
-    AptlyAlgorithmPipelineApplyTo["Base"] = "base";
     AptlyAlgorithmPipelineApplyTo["Root"] = "root";
+    AptlyAlgorithmPipelineApplyTo["Base"] = "base";
     AptlyAlgorithmPipelineApplyTo["PreviousStep"] = "previousStep";
 })(AptlyAlgorithmPipelineApplyTo || (AptlyAlgorithmPipelineApplyTo = {}));

package/models/app.d.ts

@@ -67,6 +67,7 @@ export declare enum AptlyOrganizationInjection {
     Base = "",
     Project = "project",
     Options = "options",
+    Service = "service",
     Products = "products",
     Content = "content",
     Admin = "admin"
@@ -74,6 +75,7 @@ export declare enum AptlyOrganizationInjection {
 export declare enum AptlyProjectInjection {
     Base = "",
     Options = "options",
+    Service = "service",
     Products = "products",
     Content = "content",
     Project = "project",
@@ -83,6 +85,7 @@ export declare enum AptlyProjectInjection {
 export declare enum AptlyUnitInjection {
     Base = "",
     Options = "options",
+    Service = "service",
     Reports = "reports",
     Support = "support",
     Admin = "admin"

package/models/app.js

@@ -26,6 +26,7 @@ export var AptlyOrganizationInjection;
     AptlyOrganizationInjection["Base"] = "";
     AptlyOrganizationInjection["Project"] = "project";
     AptlyOrganizationInjection["Options"] = "options";
+    AptlyOrganizationInjection["Service"] = "service";
     AptlyOrganizationInjection["Products"] = "products";
     AptlyOrganizationInjection["Content"] = "content";
     AptlyOrganizationInjection["Admin"] = "admin";
@@ -34,6 +35,7 @@ export var AptlyProjectInjection;
 (function (AptlyProjectInjection) {
     AptlyProjectInjection["Base"] = "";
     AptlyProjectInjection["Options"] = "options";
+    AptlyProjectInjection["Service"] = "service";
     AptlyProjectInjection["Products"] = "products";
     AptlyProjectInjection["Content"] = "content";
     AptlyProjectInjection["Project"] = "project";
@@ -44,6 +46,7 @@ export var AptlyUnitInjection;
 (function (AptlyUnitInjection) {
     AptlyUnitInjection["Base"] = "";
     AptlyUnitInjection["Options"] = "options";
+    AptlyUnitInjection["Service"] = "service";
     AptlyUnitInjection["Reports"] = "reports";
     AptlyUnitInjection["Support"] = "support";
     AptlyUnitInjection["Admin"] = "admin";

package/models/customer.d.ts

@@ -0,0 +1,9 @@
+import { AptlyUserSchema } from './user.js';
+export type AptlyCustomer = AptlyCustomerSchema<string, string>;
+export interface AptlyCustomerSchema<ID, DATE> {
+    user?: ID | AptlyUserSchema<ID, DATE> | null;
+    firstName: string;
+    lastName: string;
+    email: string;
+    phone?: string;
+}

package/models/customer.js

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

package/models/extends.d.ts

@@ -1,5 +1,5 @@
-import { AptlyUserSchema } from './user.js';
 import { AptlyHistoryType } from '../enums/index.js';
+import { AptlyUserSchema } from './user.js';
 export interface AptlyBaseSchema<ID, DATE> {
     _id: ID;
     name: string;
@@ -27,11 +27,3 @@ export interface AptlyDBCrawlerCleaner {
     dontClean?: boolean;
     lastClean?: boolean;
 }
-export interface AptlyAddress {
-    line1?: string;
-    line2?: string;
-    street?: string;
-    zip?: string;
-    city?: string;
-    country?: string;
-}

package/models/index.d.ts

@@ -1,16 +1,21 @@
+export * from './address.js';
 export * from './algorithm.js';
 export * from './app.js';
 export * from './booking.js';
 export * from './client.js';
+export * from './customer.js';
 export * from './department.js';
 export * from './document.js';
 export * from './email.js';
 export * from './extends.js';
 export * from './inquiry.js';
+export * from './invite.js';
+export * from './item.js';
 export * from './media.js';
 export * from './module.js';
 export * from './note.js';
 export * from './notification-trigger.js';
+export * from './offer.js';
 export * from './option.js';
 export * from './option-label.js';
 export * from './order.js';

package/models/index.js

@@ -1,16 +1,21 @@
+export * from './address.js';
 export * from './algorithm.js';
 export * from './app.js';
 export * from './booking.js';
 export * from './client.js';
+export * from './customer.js';
 export * from './department.js';
 export * from './document.js';
 export * from './email.js';
 export * from './extends.js';
 export * from './inquiry.js';
+export * from './invite.js';
+export * from './item.js';
 export * from './media.js';
 export * from './module.js';
 export * from './note.js';
 export * from './notification-trigger.js';
+export * from './offer.js';
 export * from './option.js';
 export * from './option-label.js';
 export * from './order.js';

package/models/invite.d.ts

@@ -0,0 +1,18 @@
+export type AptlyInvite = AptlyInviteSchema<string, string>;
+export interface AptlyInviteSchema<ID, DATE> {
+    _id: ID;
+    code: string;
+    created: DATE;
+    createdBy: ID;
+    sendCount: number;
+    claim: AptlyInviteClaimSchema<ID, DATE>;
+}
+export type AptlyInviteClaim = AptlyInviteClaimSchema<string, string>;
+export interface AptlyInviteClaimSchema<ID, DATE> {
+    email: string;
+    fullName?: string;
+    phone?: string;
+    claimed?: boolean;
+    claimedBy?: ID | null;
+    claimTime?: DATE | null;
+}

package/models/invite.js

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

package/models/item.d.ts

@@ -0,0 +1,28 @@
+import { AptlyInternationalCodeDesignator } from '../enums/index.js';
+import { AptlyVatCategory } from './algorithm.js';
+import { AptlyMediaSrc } from './media.js';
+export interface AptlyItem {
+    name: string;
+    type: AptlyItemType;
+    description: string;
+    buyersIdentification: string;
+    sellersIdentification: string;
+    standardIdentification: AptlyItemStandardIdentification | null;
+    vatCategory: AptlyVatCategory;
+    thumbnail: AptlyMediaSrc | null;
+    producer?: string;
+    properties: AptlyItemProperty[];
+}
+export declare enum AptlyItemType {
+    Physical = "physical",
+    Digital = "digital",
+    Service = "service"
+}
+export interface AptlyItemStandardIdentification {
+    scheme: AptlyInternationalCodeDesignator;
+    value: string;
+}
+export interface AptlyItemProperty {
+    name: string;
+    value: string;
+}

package/models/item.js

@@ -0,0 +1,6 @@
+export var AptlyItemType;
+(function (AptlyItemType) {
+    AptlyItemType["Physical"] = "physical";
+    AptlyItemType["Digital"] = "digital";
+    AptlyItemType["Service"] = "service";
+})(AptlyItemType || (AptlyItemType = {}));

package/models/note.d.ts

@@ -1,3 +1,4 @@
+import { AptlyCategorySchema } from './category.js';
 import { AptlyBaseSchema } from './extends.js';
 import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyProjectSchema } from './project.js';
@@ -9,6 +10,7 @@ export interface AptlyNoteSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE>;
+    category: ID | AptlyCategorySchema<ID, DATE> | null;
     users: (ID | AptlyUserSchema<ID, DATE>)[];
     addToReceipt: boolean;
     unitTemplateCategory: ID | null;

package/models/offer.d.ts

@@ -0,0 +1,64 @@
+import { AptlyCurrency, AptlyVatCategoryCode } from '../enums/index.js';
+import { AptlyAddress, AptlySearchAddress } from './address.js';
+import { AptlyExtensionAmount } from './algorithm.js';
+import { AptlyCustomer, AptlyCustomerSchema } from './customer.js';
+import { AptlyDocumentSchema } from './document.js';
+import { AptlyBaseSchema } from './extends.js';
+import { AptlyOptionPopulatedSchema, AptlyOptionSchema } from './option.js';
+import { AptlyOrderPaymentStatus, AptlyOrderSchema } from './order.js';
+import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyPickSchema } from './pick.js';
+import { AptlyProjectSchema } from './project.js';
+import { AptlyUnitSchema } from './unit.js';
+import { AptlyUserSchema } from './user.js';
+export type AptlyOffer = AptlyOfferSchema<string, string>;
+export interface AptlyOfferSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE>, AptlyExtensionAmount {
+    organization: ID | AptlyOrganizationSchema<ID, DATE>;
+    project: ID | AptlyProjectSchema<ID, DATE>;
+    unit: ID | AptlyUnitSchema<ID, DATE> | null;
+    order: ID | AptlyOrderSchema<ID, DATE> | null;
+    document: ID | AptlyDocumentSchema<ID, DATE> | null;
+    expiresAt: DATE | null;
+    sentAt: DATE | null;
+    number?: number;
+    description: string;
+    identification?: string;
+    amount?: number;
+    algorithm: ID | null;
+    currency: AptlyCurrency;
+    vatCategory: AptlyVatCategoryCode;
+    items: AptlyOfferItemSchema<ID, DATE>[];
+    customer: AptlyCustomerSchema<ID, DATE> | null;
+    shipping: AptlyAddress | null;
+    acceptedAt: DATE | null;
+    acceptedBy: ID | AptlyUserSchema<ID, DATE> | null;
+    locked: boolean;
+}
+export type AptlyOfferItem = AptlyOfferItemSchema<string, string>;
+export interface AptlyOfferItemSchema<ID, DATE> {
+    _id: ID;
+    option: ID | AptlyOptionSchema<ID, DATE>;
+    quantity: number;
+    amount: number;
+    algorithm: ID | null;
+    createdAt?: DATE;
+}
+export type AptlyUserOffer = AptlyUserOfferSchema<string, string>;
+export interface AptlyUserOfferSchema<ID, DATE> extends Omit<AptlyOfferSchema<ID, DATE>, 'amount' | 'items'> {
+    options: AptlyOptionPopulatedSchema<ID, DATE>[];
+    picks?: AptlyPickSchema<ID, DATE>[];
+}
+export interface AptlyOfferSendBody extends Omit<AptlyCustomer, 'user'> {
+    unit: string | null;
+    copy?: boolean;
+    address?: AptlySearchAddress | null;
+}
+export type AptlyPublicOfferCheckout = AptlyPublicOfferCheckoutSchema<string, string>;
+export interface AptlyPublicOfferCheckoutSchema<ID, DATE> extends AptlyExtensionAmount {
+    status: AptlyOrderPaymentStatus;
+    offer: Omit<AptlyUserOfferSchema<ID, DATE>, 'options'>;
+    options: AptlyOptionPopulatedSchema<ID, DATE>[];
+    organization: Pick<AptlyOrganizationSchema<ID, DATE>, 'name'>;
+    project: Pick<AptlyProjectSchema<ID, DATE>, 'name' | 'paymentApp' | 'signApp'>;
+    order?: Pick<AptlyOrderSchema<ID, DATE>, '_id' | 'status' | 'paymentSession'>;
+}

package/models/offer.js

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

package/models/option.d.ts

@@ -1,8 +1,12 @@
 import { AptlyCurrency, AptlyVatCategoryCode, AptlyQuantityUnitCode } from '../enums/index.js';
-import { AptlyAlgorithmPipelineData } from './algorithm.js';
+import { AptlyAllowanceChargeSchema, AptlyAllowance, AptlyExtensionAmount, AptlyPrice } from './algorithm.js';
 import { AptlyBaseSchema } from './extends.js';
+import { AptlyItem, AptlyItemType } from './item.js';
+import { AptlyMediaSrcSchema } from './media.js';
+import { AptlyOfferSchema } from './offer.js';
 import { AptlyOrganizationSchema } from './organization.js';
 import { AptlyPeriodSchema } from './period.js';
+import { AptlyProducerSchema } from './producer.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProjectSchema } from './project.js';
 import { AptlyCategorySchema } from './category.js';
@@ -12,32 +16,36 @@ export interface AptlyOptionSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE> | null;
-    product?: ID | AptlyProductSchema<ID, DATE> | null;
-    period?: ID | AptlyPeriodSchema<ID, DATE> | null;
-    algorithm?: ID | null;
+    product: ID | AptlyProductSchema<ID, DATE> | null;
+    producer: ID | AptlyProducerSchema<ID, DATE> | null;
+    offer: ID | AptlyOfferSchema<ID, DATE> | null;
+    offerItem: ID | null;
+    period: ID | AptlyPeriodSchema<ID, DATE> | null;
+    algorithm: ID | null;
+    thumbnail: AptlyMediaSrcSchema<ID, DATE> | null;
+    title: string;
     description: string;
     identification: string;
-    quantity: number;
+    type: AptlyItemType;
+    quantity?: number;
     quantityUnitCode: AptlyQuantityUnitCode;
     quantityCategory: ID | AptlyCategorySchema<ID, DATE> | null;
     quantityCategoryKey?: string;
     amount: number;
-    amountCategory: ID | AptlyCategorySchema<ID, DATE> | null;
-    amountCategoryKey?: string;
     currency: AptlyCurrency;
     vatCategory: AptlyVatCategoryCode;
+    amountCategory: ID | AptlyCategorySchema<ID, DATE> | null;
+    amountCategoryKey?: string;
+    allowance?: AptlyAllowance;
+    allowanceCharge: AptlyAllowanceChargeSchema<ID, boolean>[];
 }
 export type AptlyOptionPopulated = AptlyOptionPopulatedSchema<string, string>;
-export interface AptlyOptionPopulatedSchema<ID, DATE> extends Omit<AptlyOptionSchema<ID, DATE>, 'product'> {
-    price: AptlyOptionPopulatedPrice;
+export interface AptlyOptionPopulatedSchema<ID, DATE> extends Omit<AptlyOptionSchema<ID, DATE>, 'product'>, AptlyExtensionAmount {
+    invoicedQuantity: number;
+    item: AptlyItem;
+    price: AptlyPrice;
     quantityCategory: AptlyCategorySchema<ID, DATE> | null;
     amountCategory: AptlyCategorySchema<ID, DATE> | null;
-    period?: AptlyPeriodSchema<ID, DATE> | null;
-    product?: AptlyProductSchema<ID, DATE> | null;
-}
-export interface AptlyOptionPopulatedPrice {
-    amount: number;
-    vat: number;
-    vatAmount: number;
-    pipeline: AptlyAlgorithmPipelineData[];
+    period: AptlyPeriodSchema<ID, DATE> | null;
+    product: AptlyProductSchema<ID, DATE> | null;
 }

package/models/order.d.ts

@@ -1,18 +1,22 @@
 import { AptlyOrderStatus } from '../enums/index.js';
+import { AptlyAddress } from './address.js';
 import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
+import { AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyEmailSchema } from './email.js';
+import { AptlyOfferSchema } from './offer.js';
 import { AptlyOrganizationAppConfigSchema, AptlyOrganizationSchema } from './organization.js';
 import { AptlyPaymentSchema } from './payment.js';
+import { AptlyPickConfirmedSchema } from './pick.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
-import { AptlyAddress, AptlyBaseSchema } from './extends.js';
+import { AptlyBaseSchema } from './extends.js';
 import { AptlyUser, AptlyUserSchema } from './user.js';
 export declare enum AptlyOrderPaymentStatus {
     Pending = "PENDING",
-    OnHold = "ON_HOLD",
     Authorized = "AUTHORIZED",
+    OnHold = "ON_HOLD",
     Captured = "CAPTURED"
 }
 export type AptlyOrder = AptlyOrderSchema<string, string>;
@@ -22,6 +26,7 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     project: ID | AptlyProjectSchema<ID, DATE>;
     period?: ID | AptlyProjectPeriodSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE>;
+    offer: ID | AptlyOfferSchema<ID, DATE> | null;
     signers: (ID | AptlyUserSchema<ID, DATE>)[];
     status: AptlyOrderStatus;
     receipt: ID | AptlyDocumentSchema<ID, DATE>;
@@ -29,12 +34,12 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     attachments: ID[];
     signage: AptlyOrderSignageSchema<ID, DATE>;
     items: AptlyOrderItemSchema<ID, DATE>[];
-    picks: ID[];
+    picks: (ID | AptlyPickConfirmedSchema<ID, DATE>)[];
     amount?: number;
     vatAmount?: number;
     totalVat?: number;
     totalCost: number;
-    customer?: AptlyOrderCustomerSchema<ID, DATE>;
+    customer?: AptlyCustomerSchema<ID, DATE>;
     shipping?: AptlyAddress;
     billing?: AptlyAddress;
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
@@ -56,14 +61,14 @@ export type AptlyOrderPaymentSession = AptlyOrderPaymentSessionSchema<string, st
 export interface AptlyOrderPaymentSessionSchema<ID, DATE> {
     app?: ID | AptlyAppSchema<ID, DATE>;
     status?: AptlyOrderPaymentStatus;
-    url?: string;
+    user?: ID | null;
     id?: string;
     at?: DATE | null;
-    user?: ID | null;
+    url?: string;
+    notifiedAt?: DATE | null;
     expiresAt?: DATE | null;
     paidAt?: DATE | null;
     capturedAt?: DATE | null;
-    notifiedAt?: DATE | null;
 }
 export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
 export interface AptlyOrderSigneeSchema<ID, DATE> {
@@ -171,11 +176,3 @@ export interface AptlyOrderActionSignDataSignee {
     signMethod?: string;
     isAdmin?: boolean;
 }
-export type AptlyOrderCustomer = AptlyOrderCustomerSchema<string, string>;
-export interface AptlyOrderCustomerSchema<ID, DATE> {
-    user: ID | AptlyUserSchema<ID, DATE>;
-    firstName: string;
-    lastName: string;
-    email: string;
-    phone?: string;
-}

package/models/order.js

@@ -2,8 +2,8 @@ import { AptlyAppImplementationSetting } from './app.js';
 export var AptlyOrderPaymentStatus;
 (function (AptlyOrderPaymentStatus) {
     AptlyOrderPaymentStatus["Pending"] = "PENDING";
-    AptlyOrderPaymentStatus["OnHold"] = "ON_HOLD";
     AptlyOrderPaymentStatus["Authorized"] = "AUTHORIZED";
+    AptlyOrderPaymentStatus["OnHold"] = "ON_HOLD";
     AptlyOrderPaymentStatus["Captured"] = "CAPTURED";
 })(AptlyOrderPaymentStatus || (AptlyOrderPaymentStatus = {}));
 export var AptlyOrderSigneeType;

package/models/organization.d.ts

@@ -1,10 +1,12 @@
 import { AptlyModules } from '../core/index.js';
 import { AptlyOrganizationRoles, AptlyAppScope, AptlySignageSchema } from '../core/index.js';
 import { AptlyOrganizationStatus, AptlyOrganizationType } from '../enums/index.js';
+import { AptlyAddress } from './address.js';
+import { AptlyInviteSchema } from './invite.js';
 import { AptlyModuleItemSchema } from './module.js';
 import { AptlyUserSchema } from './user.js';
 import { AptlyMediaSrc } from './media.js';
-import { AptlyAddress, AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
+import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
 import { AptlyDepartmentGeneric } from './department.js';
 import { AptlyProducerSchema } from './producer.js';
 import { AptlyAppSchema } from './app.js';
@@ -72,21 +74,12 @@ export declare enum AptlyOrganizationMemberPosition {
     User = 10
 }
 export type AptlyOrganizationInvite = AptlyOrganizationInviteSchema<string, string>;
-export interface AptlyOrganizationInviteSchema<ID, DATE> {
-    _id: ID;
-    code: string;
-    created: DATE;
+export interface AptlyOrganizationInviteSchema<ID, DATE> extends AptlyInviteSchema<ID, DATE> {
     permissions?: AptlyOrganizationRoles[];
     projects?: ID[] | null;
     departments?: ID[] | null;
     position?: AptlyOrganizationMemberPosition;
-    clickCount?: number;
-    claim: {
-        email?: string;
-        claimed: boolean;
-        claimedBy: ID;
-        claimTime?: DATE;
-    };
+    clickCount: number;
 }
 export type AptlyOrganizationAppConfig<S extends object = object> = AptlyOrganizationAppConfigSchema<string, string, S>;
 export interface AptlyOrganizationAppConfigSchema<ID, DATE, S extends object = object> extends Omit<AptlyBaseSchema<ID, DATE>, 'name' | 'archived'> {

package/models/payment.d.ts

@@ -1,8 +1,11 @@
+import { AptlyAddress } from './address.js';
 import { AptlyAppSchema } from './app.js';
+import { AptlyCustomerSchema } from './customer.js';
 import { AptlyDocumentSchema } from './document.js';
-import { AptlyAddress, AptlyBaseSchema } from './extends.js';
+import { AptlyBaseSchema } from './extends.js';
 import { AptlyOrderPaymentStatus, AptlyOrderSchema } from './order.js';
 import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyPickConfirmedSchema } from './pick.js';
 import { AptlyProjectSchema } from './project.js';
 import { AptlyUnitSchema } from './unit.js';
 import { AptlyUserSchema } from './user.js';
@@ -17,15 +20,18 @@ export interface AptlyPaymentSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, D
     reportDocument?: ID | AptlyDocumentSchema<ID, DATE>;
     status: AptlyPaymentStatus;
     number: number;
+    amount: number;
+    vatAmount: number;
     totalCost: number;
     totalVat: number;
     items: AptlyPaymentItemSchema<ID>[];
+    picks: (ID | AptlyPickConfirmedSchema<ID, DATE>)[];
     transaction: {
         ref: string;
         at: DATE;
     };
     company: AptlyPaymentCompany;
-    customer: AptlyPaymentCustomerSchema<ID, DATE>;
+    customer: AptlyCustomerSchema<ID, DATE>;
     shipping: AptlyAddress;
     shippingDate?: DATE;
     shippingDescription?: string;
@@ -70,14 +76,6 @@ export interface AptlyPaymentCompany {
     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;
-}
 export interface AptlyPaymentItemSchema<ID> {
     _id: ID;
     name: string;
@@ -102,7 +100,7 @@ export interface AptlyPaymentTransactionBody {
     id: string;
     at: string;
     customer: {
-        user: string;
+        user?: string;
         firstName: string;
         lastName: string;
         email: string;

package/models/pick.d.ts

@@ -1,52 +1,53 @@
-import { AptlyCurrency, AptlyInternationalCodeDesignator, AptlyQuantityUnitCode, AptlyTaxCategoryScheme, AptlyVatCategoryCode } from '../enums/index.js';
+import { AptlyCurrency, AptlyQuantityUnitCode } from '../enums/index.js';
+import { AptlyAlgorithmPipelineDataItemSchema, AptlyPrice } from './algorithm.js';
 import { AptlyBaseSchema } from './extends.js';
-import { AptlyOptionSchema } from './option.js';
+import { AptlyOfferSchema } from './offer.js';
+import { AptlyOptionPopulatedSchema, AptlyOptionSchema } from './option.js';
+import { AptlyOrderSchema } from './order.js';
 import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyItem } from './item.js';
+import { AptlyProducerSchema } from './producer.js';
 import { AptlyProjectSchema } from './project.js';
 import { AptlyCategorySchema } from './category.js';
 import { AptlyUnitSchema } from './unit.js';
-export interface AptlyPickSchema<ID, DATE> extends Pick<AptlyBaseSchema<ID, DATE>, '_id' | 'createdAt' | 'updatedAt'> {
+export type AptlyPick = AptlyPickSchema<string, string>;
+export interface AptlyPickSchema<ID, DATE> extends Pick<AptlyBaseSchema<ID, DATE>, '_id' | 'archived' | 'createdAt' | 'updatedAt'> {
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE>;
     option: ID | AptlyOptionSchema<ID, DATE>;
     category: ID | AptlyCategorySchema<ID, DATE> | null;
-    period?: ID | null;
-    quantity: number;
+    producer: ID | AptlyProducerSchema<ID, DATE> | null;
+    offer: ID | AptlyOfferSchema<ID, DATE> | null;
+    offerItem: ID | null;
+    order: ID | AptlyOrderSchema<ID, DATE> | null;
+    period: ID | null;
+    quantity?: number;
     note: string;
-    item: AptlyPickItem | null;
-    price: AptlyPickPrice | null;
+    invoicedQuantity?: number | null;
+    quantityUnitCode?: AptlyQuantityUnitCode | null;
+    extensionAmount?: number | null;
+    extensionVatAmount?: number | null;
+    currency?: AptlyCurrency | null;
+    item: AptlyItem | null;
+    price: AptlyPrice | null;
+    algorithm: ID | null;
+    pipeline: AptlyAlgorithmPipelineDataItemSchema<ID>[];
     confirmedAt: DATE | null;
 }
-export interface AptlyPickConfirmedSchema<ID, DATE> extends AptlyPickSchema<ID, DATE> {
-    item: AptlyPickItem;
-    price: AptlyPickPrice;
+export type AptlyPickConfirmed = AptlyPickConfirmedSchema<string, string>;
+export type AptlyPickConfirmedSchema<ID, DATE> = Omit<AptlyPickSchema<ID, DATE>, 'option'> & AptlyPickConfirmedFieldsSchema<ID, DATE> & {
+    option: AptlyOptionPopulatedSchema<ID, DATE>;
+};
+export interface AptlyPickConfirmedFieldsSchema<ID, DATE> {
+    item: AptlyItem;
     confirmedAt: DATE;
-}
-export interface AptlyPickItem {
-    name: string;
-    description: string;
-    sellersIdentification?: string;
-    standardIdentification?: {
-        scheme: AptlyInternationalCodeDesignator;
-        value: string;
-    };
-    vatCategory: {
-        id: AptlyVatCategoryCode;
-        percent: number;
-        taxScheme: AptlyTaxCategoryScheme;
-    };
-    properties: AptlyPickItemProperty[];
-}
-interface AptlyPickItemProperty {
-    name: string;
-    value: string;
-}
-interface AptlyPickPrice {
-    quantity: number;
+    order: ID | AptlyOrderSchema<ID, DATE>;
+    invoicedQuantity: number;
     quantityUnitCode: AptlyQuantityUnitCode;
-    amount: number;
-    vatAmount: number;
+    price: AptlyPrice;
+    extensionAmount: number;
+    extensionVatAmount: number;
     currency: AptlyCurrency;
+    pipeline: AptlyAlgorithmPipelineDataItemSchema<ID>[];
 }
-export {};

package/models/project.d.ts

@@ -1,11 +1,12 @@
 import { AptlyEmailType, AptlyProjectStatus } from '../enums/index.js';
+import { AptlyAddress } from './address.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';
 import { AptlyUserSchema } from './user.js';
-import { AptlyAddress, AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
+import { AptlyBaseSchema, AptlyHistorySchema } from './extends.js';
 import { AptlyDocumentSchema } from './document.js';
 import { AptlyUnitOptionExtraItemSchema } from './unit.js';
 import { AptlyMediaSrc } from './media.js';

package/models/unit.d.ts

@@ -1,11 +1,13 @@
+import { AptlyAddress } from './address.js';
 import { AptlyCategorySchema } from './category.js';
 import { AptlyDocumentSchema } from './document.js';
+import { AptlyInviteSchema } from './invite.js';
 import { AptlyOrderSchema } from './order.js';
 import { AptlyPeriodSchema } from './period.js';
 import { AptlyProducerSchema } from './producer.js';
 import { AptlyProductSchema } from './product.js';
 import { AptlyProjectSchema } from './project.js';
-import { AptlyAddress, AptlyHistorySchema } from './extends.js';
+import { 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';
@@ -14,6 +16,7 @@ export type AptlyUnit = AptlyUnitSchema<string, string>;
 export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<ID, DATE>, AptlyUnitEditData<DATE>, AptlyHistorySchema<ID, DATE> {
     status: AptlyUnitStatus;
     vat?: string;
+    addressHash?: string;
     shipping?: AptlyAddress;
     billing?: AptlyAddress;
     rooms: AptlyUnitRoomSchema<ID, DATE>[];
@@ -26,7 +29,7 @@ export interface AptlyUnitSchema<ID, DATE> extends AptlyUnitTemplateBaseSchema<I
     productOverrides: AptlyUnitProductOverrideSchema<ID>[];
     ordersToSign: ID[];
     categoriesRead: ID[];
-    spec: AptlyUnitSpec;
+    spec: AptlyUnitSpec<ID>;
     buildStep: number;
     documents: (AptlyDocumentSchema<ID, DATE> | ID)[];
     unitPlans: {
@@ -169,8 +172,9 @@ export interface AptlyUnitProductOverrideVariantPriceSchema<ID> {
     variant: ID;
     price: number;
 }
-export interface AptlyUnitSpec {
+export interface AptlyUnitSpec<ID> {
     categories: {
+        _id: ID;
         name: string;
         isRoom: boolean;
         size: number;
@@ -209,7 +213,8 @@ interface AptlyUnitEditData<DATE> {
     garagePortNumber?: string;
     garagePowerID?: string;
     electricCar?: string;
-    unitNumber?: number;
+    unitNumber?: string;
+    countyNumber?: string;
     holdingNumber?: number;
     subHoldingNumber?: number;
     leaseNumber?: number;
@@ -234,22 +239,9 @@ export interface AptlyUnitInviteQueueSchema {
     fullName?: string;
     phone?: string;
 }
-export interface AptlyUnitInviteSchema<ID, DATE> {
-    _id: ID;
-    code: string;
-    created: DATE;
-    createdBy?: ID | AptlyUserSchema<ID, DATE>;
+export interface AptlyUnitInviteSchema<ID, DATE> extends AptlyInviteSchema<ID, DATE> {
     newOwner: boolean;
     allowAsGuest?: boolean;
-    sendCount?: number;
-    claim: {
-        email: string;
-        fullName?: string;
-        phone?: string;
-        claimed: boolean;
-        claimedBy?: ID;
-        claimTime?: DATE;
-    };
 }
 export type AptlyUnitPeriod = AptlyUnitPeriodSchema<string, string>;
 export type AptlyUnitPeriodSchema<ID, DATE> = AptlyPeriodSchema<ID, DATE> & Pick<AptlyUnitConfirmedPeriodSchema<ID, DATE>, 'confirmed' | 'order'>;

package/package.json

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