@managemint-solutions/entities 1.46.0 → 1.47.0

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

@@ -146,3 +146,21 @@ export type DocumentPaymentIdDto = {
     documentId: string;
     paymentId: string;
 };
+export type GetCatalogueTemplatesDto = {
+    /** Matches the title, description, category and tags. */
+    search?: string | null;
+    category?: string | null;
+};
+export type CatalogueTemplateSlugDto = {
+    slug: string;
+};
+/**
+ * Copies a catalogue template into the caller's organization as an ordinary template. `name` and
+ * `number_prefix`, when given, are what the copy is called and numbered under - checked like a
+ * template save (409 when another template has either); omitted, the copy takes the first free
+ * one (`CatalogueTemplateSuggestion`).
+ */
+export type CopyCatalogueTemplateDto = CatalogueTemplateSlugDto & {
+    name?: string;
+    number_prefix?: string;
+};

package/dist/documents/index.d.ts

@@ -318,6 +318,13 @@ export type PublicDocumentPayment = {
     status: DocumentPayStatus;
     /** Prefills the payer's email; null when the document has no client email. */
     client_email: string | null;
+    /**
+     * What was paid (integer cents, every settled payment together) and when the first payment
+     * landed (an ISO date-time) - on a paid document, and on a void one paid before it was voided,
+     * whose refund its organization arranges. Both null when nothing has been paid.
+     */
+    paid_minor: number | null;
+    paid_at: string | null;
 };
 /** Where the payer goes next: Paystack's hosted checkout. */
 export type DocumentCheckout = {
@@ -387,4 +394,40 @@ export type DocumentValueChange = {
     old: DocumentVariableValue | null;
     new: DocumentVariableValue | null;
 };
+/**
+ * One of the platform's starter templates, as the catalogue lists it (`GET /catalogue/templates`):
+ * public, the same for every organization, copied into one with `POST /document-templates/from-catalogue`.
+ */
+export type CatalogueTemplateSummary = {
+    /** Its address: lower-case words joined by hyphens, e.g. `residential-lease-za`. */
+    slug: string;
+    title: string;
+    /** One or two plain sentences. */
+    description: string;
+    tags: string[];
+    /** The category the copy gets, e.g. Invoice, Contract, Letter. */
+    category: string;
+};
+/**
+ * The name and prefix a copy of a catalogue template would take in the caller's organization
+ * (`GET /catalogue/templates/:slug/suggestion`): the entry's own, or the first free "Invoice (2)"
+ * and "INV2-" when the organization already uses them.
+ */
+export type CatalogueTemplateSuggestion = {
+    name: string;
+    number_prefix: string;
+};
+/** The whole entry (`GET /catalogue/templates/:slug`): what a copy is made of, and its preview's values. */
+export type CatalogueTemplate = CatalogueTemplateSummary & {
+    /**
+     * What the copy is called and what its documents print as their title ("Tax Invoice"); the
+     * `title` is the catalogue's listing name.
+     */
+    name: string;
+    number_prefix: string;
+    variables: DocumentVariable[];
+    blocks: DocumentBlock[];
+    /** Filled in on the preview PDF only - never copied. */
+    sample_values: DocumentVariableValues;
+};
 export {};

package/package.json

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