@managemint-solutions/entities 1.1.26 → 1.1.29

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

@@ -39,3 +39,44 @@ export declare enum BillingEventSource {
     WEBHOOK = "webhook",
     SCHEDULER = "scheduler"
 }
+/**
+ * Billing ledger event names — the values written to billing_events.event_type.
+ * Distinct from BillingStatus (which is the organization's current billing state)
+ * even though a couple of values coincide, e.g. cancellation_requested.
+ */
+export declare enum BillingEventType {
+    CHECKOUT_RESUMED = "checkout_resumed",
+    CHECKOUT_FAILED = "checkout_failed",
+    CHECKOUT_CREATED = "checkout_created",
+    IDEMPOTENCY_KEY_REPLAYED = "idempotency_key_replayed",
+    TRANSACTION_INITIALIZED = "transaction_initialized",
+    SEAT_CHARGE_FAILED = "seat_charge_failed",
+    SEAT_CHARGED = "seat_charged",
+    MODULE_PURCHASE_FAILED = "module_purchase_failed",
+    MODULE_PURCHASED = "module_purchased",
+    PLAN_RESIZED = "plan_resized",
+    CANCELLATION_REQUESTED = "cancellation_requested",
+    CANCELLATION_REQUEST_FAILED = "cancellation_request_failed",
+    PAYSTACK_SUBSCRIPTION_DISABLE_REQUESTED = "paystack_subscription_disable_requested",
+    REINSTATEMENT_REQUESTED = "reinstatement_requested",
+    CARD_UPDATE_LINK_ISSUED = "card_update_link_issued",
+    REINSTATEMENT_SUBSCRIPTION_CREATE_FAILED = "reinstatement_subscription_create_failed",
+    PAYSTACK_SUBSCRIPTION_REQUESTED = "paystack_subscription_requested",
+    PAYSTACK_SUBSCRIPTION_ADOPTED = "paystack_subscription_adopted",
+    PAYSTACK_CUSTOMER_CREATED = "paystack_customer_created",
+    PAYSTACK_CUSTOMER_ADOPTED = "paystack_customer_adopted",
+    PAYSTACK_PLAN_CREATED = "paystack_plan_created",
+    PROVISIONING_STEP_FAILED = "provisioning_step_failed",
+    CHARGE_SUCCESS_PROCESSED = "charge_success_processed",
+    RENEWAL_RECORDED_STALE_SUBSCRIPTION = "renewal_recorded_stale_subscription",
+    RENEWAL_RECORDED = "renewal_recorded",
+    SUBSCRIPTION_CREATE_IGNORED_STALE = "subscription_create_ignored_stale",
+    SUBSCRIPTION_ACTIVATED = "subscription_activated",
+    INVOICE_PAYMENT_FAILED = "invoice_payment_failed",
+    CANCELLATION_SCHEDULED = "cancellation_scheduled",
+    WEBHOOK_IGNORED_UNEXPECTED_STATUS = "webhook_ignored_unexpected_status",
+    SUBSCRIPTION_CANCELLED = "subscription_cancelled",
+    CARD_EXPIRING_SOON = "card_expiring_soon",
+    WEBHOOK_IGNORED_STALE_SUBSCRIPTION = "webhook_ignored_stale_subscription",
+    SEAT_RELEASED = "seat_released"
+}

package/dist/billing/enum/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BillingEventSource = exports.PaystackWebhookProcessingStatus = exports.BillingTransactionStatus = exports.BillingTransactionType = exports.BillingStatus = void 0;
+exports.BillingEventType = exports.BillingEventSource = exports.PaystackWebhookProcessingStatus = exports.BillingTransactionStatus = exports.BillingTransactionType = exports.BillingStatus = void 0;
 var BillingStatus;
 (function (BillingStatus) {
     BillingStatus["PENDING_CUSTOMER_CREATION"] = "pending_customer_creation";
@@ -52,3 +52,46 @@ var BillingEventSource;
     BillingEventSource["SCHEDULER"] = "scheduler";
 })(BillingEventSource || (exports.BillingEventSource = BillingEventSource = {}));
 ;
+/**
+ * Billing ledger event names — the values written to billing_events.event_type.
+ * Distinct from BillingStatus (which is the organization's current billing state)
+ * even though a couple of values coincide, e.g. cancellation_requested.
+ */
+var BillingEventType;
+(function (BillingEventType) {
+    BillingEventType["CHECKOUT_RESUMED"] = "checkout_resumed";
+    BillingEventType["CHECKOUT_FAILED"] = "checkout_failed";
+    BillingEventType["CHECKOUT_CREATED"] = "checkout_created";
+    BillingEventType["IDEMPOTENCY_KEY_REPLAYED"] = "idempotency_key_replayed";
+    BillingEventType["TRANSACTION_INITIALIZED"] = "transaction_initialized";
+    BillingEventType["SEAT_CHARGE_FAILED"] = "seat_charge_failed";
+    BillingEventType["SEAT_CHARGED"] = "seat_charged";
+    BillingEventType["MODULE_PURCHASE_FAILED"] = "module_purchase_failed";
+    BillingEventType["MODULE_PURCHASED"] = "module_purchased";
+    BillingEventType["PLAN_RESIZED"] = "plan_resized";
+    BillingEventType["CANCELLATION_REQUESTED"] = "cancellation_requested";
+    BillingEventType["CANCELLATION_REQUEST_FAILED"] = "cancellation_request_failed";
+    BillingEventType["PAYSTACK_SUBSCRIPTION_DISABLE_REQUESTED"] = "paystack_subscription_disable_requested";
+    BillingEventType["REINSTATEMENT_REQUESTED"] = "reinstatement_requested";
+    BillingEventType["CARD_UPDATE_LINK_ISSUED"] = "card_update_link_issued";
+    BillingEventType["REINSTATEMENT_SUBSCRIPTION_CREATE_FAILED"] = "reinstatement_subscription_create_failed";
+    BillingEventType["PAYSTACK_SUBSCRIPTION_REQUESTED"] = "paystack_subscription_requested";
+    BillingEventType["PAYSTACK_SUBSCRIPTION_ADOPTED"] = "paystack_subscription_adopted";
+    BillingEventType["PAYSTACK_CUSTOMER_CREATED"] = "paystack_customer_created";
+    BillingEventType["PAYSTACK_CUSTOMER_ADOPTED"] = "paystack_customer_adopted";
+    BillingEventType["PAYSTACK_PLAN_CREATED"] = "paystack_plan_created";
+    BillingEventType["PROVISIONING_STEP_FAILED"] = "provisioning_step_failed";
+    BillingEventType["CHARGE_SUCCESS_PROCESSED"] = "charge_success_processed";
+    BillingEventType["RENEWAL_RECORDED_STALE_SUBSCRIPTION"] = "renewal_recorded_stale_subscription";
+    BillingEventType["RENEWAL_RECORDED"] = "renewal_recorded";
+    BillingEventType["SUBSCRIPTION_CREATE_IGNORED_STALE"] = "subscription_create_ignored_stale";
+    BillingEventType["SUBSCRIPTION_ACTIVATED"] = "subscription_activated";
+    BillingEventType["INVOICE_PAYMENT_FAILED"] = "invoice_payment_failed";
+    BillingEventType["CANCELLATION_SCHEDULED"] = "cancellation_scheduled";
+    BillingEventType["WEBHOOK_IGNORED_UNEXPECTED_STATUS"] = "webhook_ignored_unexpected_status";
+    BillingEventType["SUBSCRIPTION_CANCELLED"] = "subscription_cancelled";
+    BillingEventType["CARD_EXPIRING_SOON"] = "card_expiring_soon";
+    BillingEventType["WEBHOOK_IGNORED_STALE_SUBSCRIPTION"] = "webhook_ignored_stale_subscription";
+    BillingEventType["SEAT_RELEASED"] = "seat_released";
+})(BillingEventType || (exports.BillingEventType = BillingEventType = {}));
+;

package/dist/billing/index.d.ts

@@ -1,4 +1,4 @@
-import { BillingTransactionStatus, BillingTransactionType } from "./enum";
+import { BillingEventSource, BillingEventType, BillingTransactionStatus, BillingTransactionType } from "./enum";
 /**
  * Day of the month every billing period is anchored on. The period containing a
  * given date runs from the most recent 25th (inclusive) to the next 25th
@@ -12,8 +12,8 @@ export type BillingPeriod = {
 export type CreateBillingEventDto = {
     organization_id: string;
     billing_transaction_id: string | null;
-    event_type: string;
-    event_source: string;
+    event_type: BillingEventType;
+    event_source: BillingEventSource;
     created_by: string | null;
     idempotency_key: string | null;
     details: object;

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

@@ -0,0 +1,9 @@
+export type GetNotificationsDto = {
+    search?: string | null;
+    page: number;
+    page_size: number;
+    created_after?: string | null;
+    created_before?: string | null;
+    status_in?: string | null;
+    type_in?: string | null;
+};

package/dist/notifications/dto/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,15 @@
+export declare enum NotificationStatus {
+    PENDING = "pending",
+    PROCESSING = "processing",
+    SENT = "sent",
+    FAILED = "failed"
+}
+export declare enum NotificationChannel {
+    EMAIL = "email"
+}
+export declare enum NotificationType {
+    INVOICE_PAYMENT_FAILED = "invoice_payment_failed",
+    CARD_EXPIRING_SOON = "card_expiring_soon",
+    PAYMENT_RECOVERED = "payment_recovered",
+    ORGANIZATION_PROVISIONED = "organization_provisioned"
+}

package/dist/notifications/enum/index.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationType = exports.NotificationChannel = exports.NotificationStatus = void 0;
+var NotificationStatus;
+(function (NotificationStatus) {
+    NotificationStatus["PENDING"] = "pending";
+    NotificationStatus["PROCESSING"] = "processing";
+    NotificationStatus["SENT"] = "sent";
+    NotificationStatus["FAILED"] = "failed";
+})(NotificationStatus || (exports.NotificationStatus = NotificationStatus = {}));
+;
+var NotificationChannel;
+(function (NotificationChannel) {
+    NotificationChannel["EMAIL"] = "email";
+})(NotificationChannel || (exports.NotificationChannel = NotificationChannel = {}));
+;
+var NotificationType;
+(function (NotificationType) {
+    NotificationType["INVOICE_PAYMENT_FAILED"] = "invoice_payment_failed";
+    NotificationType["CARD_EXPIRING_SOON"] = "card_expiring_soon";
+    NotificationType["PAYMENT_RECOVERED"] = "payment_recovered";
+    NotificationType["ORGANIZATION_PROVISIONED"] = "organization_provisioned";
+})(NotificationType || (exports.NotificationType = NotificationType = {}));
+;

package/dist/notifications/index.d.ts

@@ -0,0 +1,18 @@
+import type { UUID } from 'crypto';
+import { UserIdentity } from '../users';
+import { NotificationChannel, NotificationStatus, NotificationType } from './enum';
+export * from './enum';
+export interface NotificationSummary {
+    mms_id: UUID;
+    created_at: Date;
+    recipient: UserIdentity | null;
+    recipient_email: string;
+    notification_type: NotificationType;
+    channel: NotificationChannel;
+    template_id: string;
+    status: NotificationStatus;
+    attempts: number;
+    sent_at: Date | null;
+    failed_at: Date | null;
+    failure_reason: string | null;
+}

package/dist/notifications/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./enum"), exports);

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

@@ -2,3 +2,10 @@ export declare enum OrganizationTypes {
     COMPANY = "Company",
     SOLE_TRADER = "Sole-Trader"
 }
+/**
+ * How often an organization is billed. Only monthly billing exists today — add
+ * members when the product supports more.
+ */
+export declare enum PaymentFrequency {
+    MONTHLY = "monthly"
+}

package/dist/organization/enum/index.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganizationTypes = void 0;
+exports.PaymentFrequency = exports.OrganizationTypes = void 0;
 var OrganizationTypes;
 (function (OrganizationTypes) {
     OrganizationTypes["COMPANY"] = "Company";
     OrganizationTypes["SOLE_TRADER"] = "Sole-Trader";
 })(OrganizationTypes || (exports.OrganizationTypes = OrganizationTypes = {}));
 ;
+/**
+ * How often an organization is billed. Only monthly billing exists today — add
+ * members when the product supports more.
+ */
+var PaymentFrequency;
+(function (PaymentFrequency) {
+    PaymentFrequency["MONTHLY"] = "monthly";
+})(PaymentFrequency || (exports.PaymentFrequency = PaymentFrequency = {}));
+;

package/dist/organization/index.d.ts

@@ -2,6 +2,7 @@ import { UUID } from 'crypto';
 import { PricebookWithModules, PricedModule } from '../modules/index';
 import { UserIdentity } from '../users';
 import { BillingStatus } from '../billing/enum';
+import { PaymentFrequency } from './enum';
 export type OrganizationEntity = {
     mms_id: UUID;
     created_at: Date;
@@ -44,7 +45,7 @@ export type OrganizationEntity = {
     modules: PricedModule[];
     /** The price list the organization pays, with its per-module prices. */
     pricebook: PricebookWithModules | null;
-    payment_frequency: string;
+    payment_frequency: PaymentFrequency;
     last_payment_date: Date;
     next_payment_date: Date;
     payment_status: BillingStatus;

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

@@ -12,3 +12,28 @@ export declare enum PaystackWebhookEvent {
     SUBSCRIPTIONS_WITH_EXPIRING_CARDS = "subscription.expiring_cards",
     TRANSACTION_SUCCESSFUL = "charge.success"
 }
+/**
+ * Paystack's own subscription vocabulary — an external contract we do not own, so
+ * this is not necessarily exhaustive. Provided for comparison sites only; the
+ * `status` fields on the payload interfaces deliberately stay `string`.
+ */
+export declare enum PaystackSubscriptionStatus {
+    ACTIVE = "active",
+    NON_RENEWING = "non-renewing",
+    ATTENTION = "attention",
+    COMPLETED = "completed",
+    CANCELLED = "cancelled"
+}
+/**
+ * Paystack's own transaction vocabulary — an external contract we do not own, so
+ * this is not necessarily exhaustive. Provided for comparison sites only; the
+ * `status` fields on the payload interfaces deliberately stay `string`.
+ * Only SUCCESS means the charge completed and the money moved.
+ */
+export declare enum PaystackTransactionStatus {
+    SUCCESS = "success",
+    FAILED = "failed",
+    PENDING = "pending",
+    SEND_OTP = "send_otp",
+    ABANDONED = "abandoned"
+}

package/dist/paystack/enum/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaystackWebhookEvent = void 0;
+exports.PaystackTransactionStatus = exports.PaystackSubscriptionStatus = exports.PaystackWebhookEvent = void 0;
 var PaystackWebhookEvent;
 (function (PaystackWebhookEvent) {
     PaystackWebhookEvent["INVOICE_CREATED"] = "invoice.create";
@@ -17,3 +17,32 @@ var PaystackWebhookEvent;
     PaystackWebhookEvent["TRANSACTION_SUCCESSFUL"] = "charge.success";
 })(PaystackWebhookEvent || (exports.PaystackWebhookEvent = PaystackWebhookEvent = {}));
 ;
+/**
+ * Paystack's own subscription vocabulary — an external contract we do not own, so
+ * this is not necessarily exhaustive. Provided for comparison sites only; the
+ * `status` fields on the payload interfaces deliberately stay `string`.
+ */
+var PaystackSubscriptionStatus;
+(function (PaystackSubscriptionStatus) {
+    PaystackSubscriptionStatus["ACTIVE"] = "active";
+    PaystackSubscriptionStatus["NON_RENEWING"] = "non-renewing";
+    PaystackSubscriptionStatus["ATTENTION"] = "attention";
+    PaystackSubscriptionStatus["COMPLETED"] = "completed";
+    PaystackSubscriptionStatus["CANCELLED"] = "cancelled";
+})(PaystackSubscriptionStatus || (exports.PaystackSubscriptionStatus = PaystackSubscriptionStatus = {}));
+;
+/**
+ * Paystack's own transaction vocabulary — an external contract we do not own, so
+ * this is not necessarily exhaustive. Provided for comparison sites only; the
+ * `status` fields on the payload interfaces deliberately stay `string`.
+ * Only SUCCESS means the charge completed and the money moved.
+ */
+var PaystackTransactionStatus;
+(function (PaystackTransactionStatus) {
+    PaystackTransactionStatus["SUCCESS"] = "success";
+    PaystackTransactionStatus["FAILED"] = "failed";
+    PaystackTransactionStatus["PENDING"] = "pending";
+    PaystackTransactionStatus["SEND_OTP"] = "send_otp";
+    PaystackTransactionStatus["ABANDONED"] = "abandoned";
+})(PaystackTransactionStatus || (exports.PaystackTransactionStatus = PaystackTransactionStatus = {}));
+;

package/dist/paystack/index.d.ts

@@ -141,9 +141,10 @@ export type PaystackChargeAuthorization = {
 export type PaystackChargeAuthorizationResponse = {
     id: number;
     /**
-     * A 2xx from Paystack only means the request was accepted. The money has only
-     * moved when this is 'success' — it can also be 'failed', 'pending', or a
-     * challenge state such as 'send_otp' when the authorization is not reusable.
+     * A 2xx from Paystack only means the request was accepted. See
+     * PaystackTransactionStatus; only PaystackTransactionStatus.SUCCESS means the
+     * charge completed and the money moved — the rest are failure, pending, or
+     * challenge states such as SEND_OTP when the authorization is not reusable.
      */
     status: string;
     reference: string;

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

@@ -0,0 +1,5 @@
+export declare enum TimesheetStatus {
+    SUBMITTED = "submitted",
+    APPROVED = "approved",
+    REJECTED = "rejected"
+}

package/dist/timesheets/enum/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimesheetStatus = void 0;
+var TimesheetStatus;
+(function (TimesheetStatus) {
+    TimesheetStatus["SUBMITTED"] = "submitted";
+    TimesheetStatus["APPROVED"] = "approved";
+    TimesheetStatus["REJECTED"] = "rejected";
+})(TimesheetStatus || (exports.TimesheetStatus = TimesheetStatus = {}));
+;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@managemint-solutions/entities",
-  "version": "1.1.26",
+  "version": "1.1.29",
   "description": "Entity types used by both the api and portal",
   "homepage": "https://github.com/ManageMint-Solutions/managemint-solutions-entities#readme",
   "bugs": {