@aptly-as/types 2.2.2 → 2.2.4

package/core/job.d.ts

@@ -14,6 +14,7 @@ export interface AptlyJob<DATA = any, RETURN = any> {
     progress: number;
     data: DATA;
     returnvalue: RETURN;
+    failedReason?: string;
 }
 export type AptlyJobOrder = AptlyJob<any, {
     order: AptlyOrder;

package/models/app.d.ts

@@ -17,15 +17,19 @@ export interface AptlyAppSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DATE>
     menus: AptlyAppMenuSchema<ID, DATE>[];
     implements: AptlyAppImplementation[];
     sign?: {
-        costPer?: number;
-        order: string;
+        orderUrl: string;
     };
 }
+export interface AptlyAppSignMethod {
+    value: string;
+    label: string;
+}
 export declare enum AptlyAppImplementation {
     Sign = "sign"
 }
 export declare enum AptlyAppImplementationSetting {
-    SignCostPer = "costPerSign"
+    SignCostPer = "costPerSign",
+    SignMethod = "signMethod"
 }
 export type AptlyAppSetting = AptlyAppSettingSchema<string>;
 export interface AptlyAppSettingSchema<ID> extends AptlyField {

package/models/app.js

@@ -5,6 +5,7 @@ export var AptlyAppImplementation;
 export var AptlyAppImplementationSetting;
 (function (AptlyAppImplementationSetting) {
     AptlyAppImplementationSetting["SignCostPer"] = "costPerSign";
+    AptlyAppImplementationSetting["SignMethod"] = "signMethod";
 })(AptlyAppImplementationSetting || (AptlyAppImplementationSetting = {}));
 export var AptlyOrganizationInjection;
 (function (AptlyOrganizationInjection) {

package/models/order.d.ts

@@ -1,7 +1,7 @@
 import { AptlyOrderStatus } from '../enums/index.js';
-import { AptlyAppSchema } from './app.js';
+import { AptlyAppImplementationSetting, AptlyAppSchema } from './app.js';
 import { AptlyDocumentSchema } from './document.js';
-import { AptlyOrganizationSchema } from './organization.js';
+import { AptlyOrganizationAppConfigSchema, AptlyOrganizationSchema } from './organization.js';
 import { AptlyProject, AptlyProjectPeriodSchema, AptlyProjectSchema } from './project.js';
 import { AptlyUnit, AptlyUnitItemParamSchema, AptlyUnitSchema } from './unit.js';
 import { AptlyBaseSchema } from './extends.js';
@@ -11,7 +11,7 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     orderNumber: string;
     organization: ID | AptlyOrganizationSchema<ID, DATE>;
     project: ID | AptlyProjectSchema<ID, DATE>;
-    period: ID | AptlyProjectPeriodSchema<ID, DATE>;
+    period?: ID | AptlyProjectPeriodSchema<ID, DATE>;
     unit: ID | AptlyUnitSchema<ID, DATE>;
     signers: (ID | AptlyUserSchema<ID, DATE>)[];
     status: AptlyOrderStatus;
@@ -24,12 +24,17 @@ export interface AptlyOrderSchema<ID, DATE> extends Omit<AptlyBaseSchema<ID, DAT
     pricePipeline: AptlyOrderPricePipelineItemSchema<ID>[];
     signees: AptlyOrderSigneeSchema<ID, DATE>[];
     emailText?: string;
+    approved?: {
+        action?: AptlyOrderAction;
+        user?: ID | AptlyUserSchema<ID, DATE>;
+        at?: DATE;
+    };
     created: DATE;
 }
 export type AptlyOrderSignee = AptlyOrderSigneeSchema<string, string>;
 export interface AptlyOrderSigneeSchema<ID, DATE> {
     _id: ID;
-    user: ID;
+    user: ID | AptlyUserSchema<ID, DATE>;
     type: AptlyOrderSigneeType;
     url: string;
     signedAt?: DATE;
@@ -80,12 +85,30 @@ export declare enum AptlyOrderAction {
     SignManually = "sign-manually",
     Sign = "sign"
 }
-export type AptlyOrderActionItem = AptlyOrderActionItemSchema<string, string>;
-export interface AptlyOrderActionItemSchema<ID, DATE> {
+export interface AptlyOrderActionPostBody {
+    action: AptlyOrderAction | null;
+    document?: string | null;
+    app?: string;
+    emailSubject: string;
+    emailText: string;
+    users: AptlyOrderActionPostBodyUser[];
+    deadlineInDays?: number;
+}
+export interface AptlyOrderActionPostBodyUser {
+    user: string;
+    signMethod?: string;
+    isAdmin?: boolean;
+}
+export type AptlyOrderActionItem<S extends object = object> = AptlyOrderActionItemSchema<string, string, S>;
+export interface AptlyOrderActionItemSchema<ID, DATE, S extends object> {
     action: AptlyOrderAction;
     path: string;
-    app?: Pick<AptlyAppSchema<ID, DATE>, '_id' | 'name' | 'sign'>;
-    costPerSign?: number;
+    app?: Pick<AptlyAppSchema<ID, DATE>, '_id' | 'name' | 'sign' | 'logo' | 'settings'>;
+    appSettings?: AptlyOrganizationAppConfigSchema<ID, DATE, S>['settings'];
+}
+export interface AptlyOrderActionItemSignSettings {
+    [AptlyAppImplementationSetting.SignCostPer]: number;
+    [AptlyAppImplementationSetting.SignMethod]: string;
 }
 export interface AptlyOrderActionSignData {
     project: Pick<AptlyProject, '_id' | 'name'> & {
@@ -93,7 +116,12 @@ export interface AptlyOrderActionSignData {
     };
     unit: Pick<AptlyUnit, '_id' | 'name'>;
     order: Pick<AptlyOrder, '_id' | 'orderNumber' | 'receipt' | 'period'>;
-    users: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone' | 'language' | 'profileImage'>[];
-    admins: Pick<AptlyUser, '_id' | 'firstName' | 'lastName' | 'fullName' | 'email' | 'phone' | 'language' | 'profileImage'>[];
-    emailText?: string;
+    user: AptlyUser;
+    signees: AptlyorderActionSignDataSignee[];
+    deadlineInDays?: number;
+}
+export interface AptlyorderActionSignDataSignee {
+    user: AptlyUser;
+    signMethod?: string;
+    isAdmin?: boolean;
 }

package/models/order.js

@@ -1,3 +1,4 @@
+import { AptlyAppImplementationSetting } from './app.js';
 export var AptlyOrderSigneeType;
 (function (AptlyOrderSigneeType) {
     AptlyOrderSigneeType[AptlyOrderSigneeType["Unit"] = 0] = "Unit";

package/models/organization.d.ts

@@ -47,9 +47,16 @@ export interface AptlyOrganizationMemberSchema<ID, DATE> {
     _id: ID;
     user: AptlyUserSchema<ID, DATE> | ID;
     permissions: AptlyOrganizationRoles[];
+    position?: AptlyOrganizationMemberPosition;
     projects?: (ID | AptlyProducerSchema<ID, DATE>)[] | null;
     departments?: (ID | AptlyDepartmentGeneric<ID, DATE>)[] | null;
 }
+export declare enum AptlyOrganizationMemberPosition {
+    Owner = 0,
+    Admin = 1,
+    Accounting = 2,
+    User = 10
+}
 export type AptlyOrganizationInvite = AptlyOrganizationInviteSchema<string, string>;
 export interface AptlyOrganizationInviteSchema<ID, DATE> {
     _id: ID;

package/models/organization.js

@@ -1 +1,7 @@
-export {};
+export var AptlyOrganizationMemberPosition;
+(function (AptlyOrganizationMemberPosition) {
+    AptlyOrganizationMemberPosition[AptlyOrganizationMemberPosition["Owner"] = 0] = "Owner";
+    AptlyOrganizationMemberPosition[AptlyOrganizationMemberPosition["Admin"] = 1] = "Admin";
+    AptlyOrganizationMemberPosition[AptlyOrganizationMemberPosition["Accounting"] = 2] = "Accounting";
+    AptlyOrganizationMemberPosition[AptlyOrganizationMemberPosition["User"] = 10] = "User";
+})(AptlyOrganizationMemberPosition || (AptlyOrganizationMemberPosition = {}));

package/models/unit-email.d.ts

@@ -28,5 +28,6 @@ export declare enum AptlyUnitEmailType {
     BookingCancel = "booking-cancel",
     OrderCreated = "order-created",
     OrderSigned = "order-signed",
-    OrderCompleted = "order-completed"
+    OrderCompleted = "order-completed",
+    ActionRecipients = "action_recipients"
 }

package/models/unit-email.js

@@ -10,4 +10,5 @@ export var AptlyUnitEmailType;
     AptlyUnitEmailType["OrderCreated"] = "order-created";
     AptlyUnitEmailType["OrderSigned"] = "order-signed";
     AptlyUnitEmailType["OrderCompleted"] = "order-completed";
+    AptlyUnitEmailType["ActionRecipients"] = "action_recipients";
 })(AptlyUnitEmailType || (AptlyUnitEmailType = {}));

package/package.json

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