@aptly-as/types 3.0.23 → 3.0.25

package/core/signage.d.ts

@@ -2,12 +2,12 @@ import { AptlySignageSignerRef } from '../enums/index.js';
 export type AptlySignage = AptlySignageSchema<string, string>;
 export interface AptlySignageSchema<ID, DATE> {
     hasReceivedFile: boolean;
-    documentId: string;
-    document: ID;
-    signedFile: ID;
+    documentId?: string;
+    document?: ID;
+    signedFile?: ID;
     signed: boolean;
-    documentCreationDate: DATE;
-    expireDate: DATE;
+    documentCreationDate?: DATE;
+    expireDate?: DATE;
     signers: AptlySignageSignerSchema<ID, DATE>[];
 }
 export type AptlySignageSigner = AptlySignageSignerSchema<string, string>;

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

@@ -1,4 +1,4 @@
-import { AptlyDocumentSchema, AptlyOrderSchema, AptlyOrganizationSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyProjectSchema, AptlyUnitSchema } from '../models/index.js';
+import { AptlyDocumentSchema, AptlyOfferSchema, AptlyOrderSchema, AptlyOrganizationSchema, AptlyPaymentSchema, AptlyPaymentSettlement, AptlyProjectSchema, AptlyUnitSchema } from '../models/index.js';
 export declare namespace AptlyWebhookEventData {
     type Organization<ID, DATE> = Pick<AptlyOrganizationSchema<ID, DATE>, '_id' | 'name' | 'logoMedia' | 'logo'>;
     type Project<ID, DATE> = Pick<AptlyProjectSchema<ID, DATE>, '_id' | 'name' | 'theme'>;
@@ -32,6 +32,7 @@ export declare namespace AptlyWebhookEventData {
         project: Project<ID, DATE>;
         unit: Pick<AptlyUnitSchema<ID, DATE>, '_id' | 'name' | 'shipping' | 'users'>;
         order: AptlyOrderSchema<ID, DATE>;
+        offer?: Pick<AptlyOfferSchema<ID, DATE>, '_id' | 'name'>;
         receiptUrl?: string;
         signedReceiptUrl?: string;
     }

package/enums/index.d.ts

@@ -114,7 +114,9 @@ export declare enum AptlyOrganizationType {
     Electrician = "electrician",
     Plumber = "plumber",
     Producer = "producer",
-    Integration = "integration"
+    Integration = "integration",
+    PropertyDeveloper = "property-developer",
+    Builder = "builder"
 }
 export declare enum AptlyOrganizationStatus {
     NewBusiness = 0,

package/enums/index.js

@@ -132,6 +132,8 @@ export var AptlyOrganizationType;
     AptlyOrganizationType["Plumber"] = "plumber";
     AptlyOrganizationType["Producer"] = "producer";
     AptlyOrganizationType["Integration"] = "integration";
+    AptlyOrganizationType["PropertyDeveloper"] = "property-developer";
+    AptlyOrganizationType["Builder"] = "builder";
 })(AptlyOrganizationType || (AptlyOrganizationType = {}));
 export var AptlyOrganizationStatus;
 (function (AptlyOrganizationStatus) {

package/models/plan-payment.d.ts

@@ -0,0 +1,31 @@
+import { AptlyCurrency, AptlyQuantityUnitCode } from '../enums/index.js';
+import { AptlyAddress } from './address.js';
+import { AptlyPrice } from './algorithm.js';
+import { AptlyCustomerSchema } from './customer.js';
+import { AptlyItemSchema } from './item.js';
+import { AptlyOrganizationSchema } from './organization.js';
+export type AptlyPlanPayment = AptlyPlanPaymentSchema<string, string>;
+export interface AptlyPlanPaymentSchema<ID, DATE> {
+    _id: ID;
+    organization: ID | AptlyOrganizationSchema<ID, DATE>;
+    offers: ID[];
+    from: DATE;
+    to: DATE;
+    amount: number;
+    vatAmount: number;
+    customer: AptlyCustomerSchema<ID, DATE>;
+    billing: AptlyAddress;
+    items: AptlyPlanPaymentItemSchema<ID, DATE>[];
+    createdAt: DATE;
+}
+export type AptlyPlanPaymentItem = AptlyPlanPaymentItemSchema<string, string>;
+export interface AptlyPlanPaymentItemSchema<ID, DATE> {
+    _id: ID;
+    item: AptlyItemSchema<ID, DATE>;
+    invoicedQuantity: number;
+    quantityUnitCode: AptlyQuantityUnitCode;
+    price: AptlyPrice;
+    extensionAmount: number;
+    extensionVatAmount: number;
+    currency: AptlyCurrency;
+}

package/models/plan-payment.js

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

package/models/plan.d.ts

@@ -0,0 +1,52 @@
+import { AptlyBaseSchema } from './extends.js';
+import { AptlyModuleSchema } from './module.js';
+import { AptlyOrganizationSchema } from './organization.js';
+export declare enum AptlyPlanRecurring {
+    None = 0,
+    Monthly = 1,
+    Yearly = 12
+}
+export declare enum AptlyPlanTier {
+    Free = 0,
+    Subscription = 1
+}
+export type AptlyPlan = AptlyPlanSchema<string, string>;
+export interface AptlyPlanSchema<ID, DATE> extends AptlyBaseSchema<ID, DATE> {
+    tier: AptlyPlanTier;
+    slug: string;
+    description: string;
+    modules: (ID | AptlyModuleSchema<ID, DATE>)[];
+    listed: boolean;
+    organization: ID | AptlyOrganizationSchema<ID, DATE> | null;
+    copiedPlan: ID | null;
+    recurring: AptlyPlanRecurring;
+    recurringAt: DATE | null;
+    subscription: {
+        monthly: number;
+        yearly: number;
+    };
+    lastPaymentAt: DATE | null;
+    nextPaymentAt: DATE | null;
+    user: {
+        freeQuantity: number;
+        monthly: number;
+        yearly: number;
+    };
+    unit: {
+        freeQuantity: number;
+        amount: number;
+    };
+    offer: {
+        freeQuantity: number;
+        monthlyQuantity: number;
+        amount: number;
+    };
+}
+export type AptlyPlanInstalled = AptlyPlanInstalledSchema<string, string>;
+export interface AptlyPlanInstalledSchema<ID, DATE> extends AptlyPlanSchema<ID, DATE> {
+    listed: false;
+    lastPaymentAt: DATE;
+    recurringAt: DATE;
+    organization: ID;
+    copiedPlan: ID;
+}

package/models/plan.js

@@ -0,0 +1,11 @@
+export var AptlyPlanRecurring;
+(function (AptlyPlanRecurring) {
+    AptlyPlanRecurring[AptlyPlanRecurring["None"] = 0] = "None";
+    AptlyPlanRecurring[AptlyPlanRecurring["Monthly"] = 1] = "Monthly";
+    AptlyPlanRecurring[AptlyPlanRecurring["Yearly"] = 12] = "Yearly";
+})(AptlyPlanRecurring || (AptlyPlanRecurring = {}));
+export var AptlyPlanTier;
+(function (AptlyPlanTier) {
+    AptlyPlanTier[AptlyPlanTier["Free"] = 0] = "Free";
+    AptlyPlanTier[AptlyPlanTier["Subscription"] = 1] = "Subscription";
+})(AptlyPlanTier || (AptlyPlanTier = {}));

package/package.json

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