@managemint-solutions/entities 1.0.9 → 1.0.11

package/dist/modules/enum/index.d.ts

@@ -0,0 +1,3 @@
+export declare enum Modules {
+    CRM = "CRM"
+}

package/dist/organization/dto/index.d.ts

@@ -0,0 +1,40 @@
+import { Modules } from "../../modules/enum";
+import { PaymentIntervals } from "../../payments/enums";
+import { OrganizationTypes } from "../enum";
+export type CreateOrganizationDto = {
+    org_type: OrganizationTypes;
+    org_name: string;
+    org_trading_name?: string | null;
+    org_vat_number?: string | null;
+    org_registration_number?: string | null;
+    org_email: string;
+    org_website?: URL | null;
+    org_phone?: string | null;
+    org_address_line_1?: string | null;
+    org_address_line_2?: string | null;
+    org_city?: string | null;
+    org_state?: string | null;
+    org_postal_code?: string | null;
+    org_country?: string | null;
+    use_address_for_billing: boolean;
+    org_billing_address_line_1?: string | null;
+    org_billing_address_line_2?: string | null;
+    org_billing_city?: string | null;
+    org_billing_state?: string | null;
+    org_billing_postal_code?: string | null;
+    org_billing_country?: string | null;
+    org_consent_given: boolean;
+    org_industry?: string | null;
+    org_marketting_consent_given: boolean;
+    org_currency: string;
+    owner_first_name: string;
+    owner_last_name: string;
+    owner_email: string;
+    owner_password: string;
+    owner_country_code: string;
+    owner_phone: string;
+    owner_profile_image?: string | null;
+    modules: Modules[];
+    seats_needed: number;
+    payment_frequency: PaymentIntervals.MONTHLY;
+};

package/dist/organization/enum/index.d.ts

@@ -0,0 +1,4 @@
+export declare enum OrganizationTypes {
+    COMPANY = "Company",
+    SOLE_TRADER = "Sole-Trader"
+}

package/dist/organization/index.d.ts

@@ -0,0 +1,54 @@
+import { UUID } from 'crypto';
+import { Modules } from '../modules/enum/index';
+import { UserIdentity } from '../users';
+import { SubscriptionCancellationStatus, SubscriptionReinstateStatus } from '../subscription/enum';
+import { PaymentStatuses } from '../payments/enums';
+export type Organization = {
+    mms_id: UUID;
+    created_at: Date;
+    type: string;
+    name: string;
+    trading_name: string;
+    vat_number: string;
+    registration_number: string;
+    email: string;
+    phone: string;
+    website: string;
+    marketing_consent: boolean;
+    industry: string;
+    currency: string;
+    updated_at: Date;
+    last_updated_by: UserIdentity | null;
+    address_details: {
+        address_line_1: string;
+        address_line_2: string;
+        city: string;
+        state: string;
+        post_code: string;
+        country: string;
+    };
+    billing_address_details: {
+        use_address_for_billing: boolean;
+        address_line_1: string;
+        address_line_2: string;
+        city: string;
+        state: string;
+        post_code: string;
+        country: string;
+    };
+    leave_calendar_start_month: number;
+    billing_cycle_locked: boolean;
+    modules: Modules[];
+    payment_frequency: string;
+    last_payment_date: Date;
+    next_payment_date: Date;
+    payment_status: PaymentStatuses;
+    payment_status_updated_at: Date;
+    seats: number;
+    cancellation_status: SubscriptionCancellationStatus;
+    reinstate_status: SubscriptionReinstateStatus;
+    card_expiring_soon: boolean;
+    card_expiry_date: string | null;
+    card_description: string | null;
+    card_brand: string | null;
+};

package/dist/payments/enums/index.d.ts

@@ -0,0 +1,39 @@
+export declare enum PaymentStatuses {
+    PAID = "paid",
+    AWAITING_INITIAL_PAYMENT = "awaiting initial payment",
+    INITIAL_AMOUNT_PAID = "initial amount paid",
+    INITIAL_PAYMENT_FAILED = "initial payment failed",
+    AWAITING_PLAN = "awaiting plan",
+    AWAITING_SUBSCRIPTION = "awaiting subscription",
+    SUBSCRIPTION_PAYMENT_FAILED = "subscription payment failed",
+    CANCELLED = "cancelled"
+}
+export declare enum PaymentIntervals {
+    HOURLY = "hourly",
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    QUARTERLY = "quarterly",
+    BIANNUALLY = "biannually",
+    ANNUALLY = "annually"
+}
+export declare enum PlanUpdateStatuses {
+    NONE = "none",
+    NEW_PLAN_REQUESTED = "new_plan_requested",
+    PRO_RATA_CHARGED = "pro_rata_charged",
+    PLAN_UPDATED = "plan_updated",
+    COMPLETED = "completed"
+}
+export declare enum PaystackWebhookEvents {
+    CHARGE_SUCCESS = "charge.success",
+    SUBSCRIPTION_CREATE = "subscription.create",
+    SUBSCRIPTION_NOT_RENEW = "subscription.not_renew",
+    SUBSCRIPTION_EXPIRING_CARDS = "subscription.expiring_cards",
+    INVOICE_PAYMENT_FAILED = "invoice.payment_failed",
+    INVOICE_CREATE = "invoice.create",
+    INVOICE_UPDATE = "invoice.update",
+    REFUND_PROCESSED = "refund.processed"
+}
+export declare enum PaystackMetadataActions {
+    INITIAL_PAYMENT = "initial-payment"
+}

package/dist/subscription/enum/index.d.ts

@@ -0,0 +1,12 @@
+export declare enum SubscriptionCancellationStatus {
+    NONE = "none",
+    PAYSTACK_SUBSCRIPTION_CANCELLED = "paystack_subscription_cancelled",
+    CANCELLED = "cancelled"
+}
+export declare enum SubscriptionReinstateStatus {
+    NONE = "none",
+    REINSTATE_REQUESTED = "reinstate_requested",
+    AUTHORIZATION_CHARGED = "authorization_charged",
+    SUBSCRIPTION_REINSTATED = "subscription_reinstated",
+    COMPLETED = "completed"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {
@@ -52,6 +52,34 @@
     "./users/enum": {
       "types": "./dist/users/enum/index.d.ts",
       "default": "./dist/users/enum/index.js"
+    },
+
+    "./organization": {
+      "types": "./dist/organization/index.d.ts",
+      "default": "./dist/organization/index.js"
+    },
+    "./organization/dto": {
+      "types": "./dist/organization/dto/index.d.ts",
+      "default": "./dist/organization/dto/index.js"
+    },
+    "./organization/enum": {
+      "types": "./dist/organization/enum/index.d.ts",
+      "default": "./dist/organization/enum/index.js"
+    },
+
+    "./modules/enum": {
+      "types": "./dist/modules/enum/index.d.ts",
+      "default": "./dist/modules/enum/index.js"
+    },
+
+    "./payments/enum": {
+      "types": "./dist/payments/enum/index.d.ts",
+      "default": "./dist/payments/enum/index.js"
+    },
+
+    "./subscription/enum": {
+      "types": "./dist/subscription/enum/index.d.ts",
+      "default": "./dist/subscription/enum/index.js"
     }
   },
   "scripts": {