@cycomdatasystems/mackinac-sdk 4.0.0 → 5.0.0

package/dist/generated/models/litigationMatterDto.d.ts

@@ -2,325 +2,514 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
+/**
+ * Data for a Litigation Case Matter.
+ */
 export interface LitigationMatterDto {
+    /** BASE.MATTER_ID and LITIGAT.MATTER_ID */
     matterId: number;
     /**
+     * BASE.CASENO
      * @minLength 0
      * @maxLength 15
      * @nullable
      */
     fileNumber?: string | null;
     /**
+     * BASE.MODULE
      * @minLength 0
      * @maxLength 3
      * @nullable
      */
     moduleCode?: string | null;
     /**
+     * BASE.TITLE
      * @minLength 0
      * @maxLength 140
      * @nullable
      */
     title?: string | null;
     /**
+     * BASE.STAFF
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     primaryAttorney?: string | null;
     /**
+     * BASE.TEAM
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     team?: string | null;
-    /** @nullable */
+    /**
+     * BASE.ADDS
+  Area Division Department Section (ADDS)
+  This is ADDS.ADDS_ID where ADDS.FullCode = display value, and ADDS.ADDS_TYPE = 'D'.
+     * @nullable
+     */
     departmentCode?: number | null;
-    /** @nullable */
+    /**
+     * BASE.ACCT
+  This is the ADDS.ADDS_ID where ADDS.FullCode = display value, and ADDS.ADDS_TYPE = 'A'.
+     * @nullable
+     */
     accountCode?: number | null;
     /**
+     * BASE.CAT
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     category?: string | null;
     /**
+     * BASE.STATUS_CD
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     statusCode?: string | null;
-    /** @nullable */
+    /**
+     * BASE.OPEN_DT
+     * @nullable
+     */
     openDate?: string | null;
-    /** @nullable */
+    /**
+     * BASE.ASSIGN_DT
+     * @nullable
+     */
     assignDate?: string | null;
-    /** @nullable */
+    /**
+     * BASE.REVIEW_DT
+     * @nullable
+     */
     reviewDate?: string | null;
     /**
+     * BASE.REVIEW
+  This is a Staff person, so it comes from STAFF.STAFF_ID.
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     reviewer?: string | null;
-    /** @nullable */
+    /**
+     * BASE.INCIDENT_DT
+     * @nullable
+     */
     incidentDate?: string | null;
     /**
+     * BASE.INCIDENT_LOC
      * @minLength 0
      * @maxLength 50
      * @nullable
      */
     incidentLocation?: string | null;
-    /** @nullable */
+    /**
+     * BASE.FILE_DT
+     * @nullable
+     */
     fileDate?: string | null;
-    /** @nullable */
+    /**
+     * BASE.SERVE_DT
+     * @nullable
+     */
     serveDate?: string | null;
     /**
+     * BASE.DISPO
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     dispositionCode?: string | null;
-    /** @nullable */
+    /**
+     * BASE.DISPO_DT
+     * @nullable
+     */
     dispositionDate?: string | null;
     /**
+     * BASE.BASE_TYPE
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     type?: string | null;
-    /** @nullable */
+    /**
+     * BASE.STATUSDATE
+     * @nullable
+     */
     statusDate?: string | null;
+    /** BASE.ISLEGALHOLD */
     isLegalHold?: boolean;
-    /** @nullable */
+    /**
+     * BASE.ISMATTERLOCKED
+     * @nullable
+     */
     isMatterLocked?: boolean | null;
     /**
+     * BASE.LOCKED_BY
      * @minLength 0
      * @maxLength 10
      * @nullable
      */
     lockedBy?: string | null;
-    /** @nullable */
+    /**
+     * BASE.LOCKED_DATE
+     * @nullable
+     */
     lockedDate?: string | null;
     /**
+     * LITIGAT.ATTY2
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     attorney2?: string | null;
     /**
+     * LITIGAT.ATTY3
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     attorney3?: string | null;
     /**
+     * LITIGAT.ATTY4
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     attorney4?: string | null;
     /**
+     * LITIGAT.ATTY5
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     attorney5?: string | null;
     /**
+     * LITIGAT.SECRETARY
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     primaryStaff?: string | null;
-    /** @nullable */
+    /**
+     * MATTERSTAFF.STAFF_ID
+     * @nullable
+     */
     secondaryStaff?: string[] | null;
     /**
+     * LITIGAT.JUDGE
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     judge?: string | null;
     /**
+     * LITIGAT.OS_COUNSEL
      * @minLength 0
      * @maxLength 8
      * @nullable
      */
     primaryOutsideCounsel?: string | null;
-    /** @nullable */
+    /**
+     * MATTERSTAFF.STAFF_ID
+     * @nullable
+     */
     secondaryOutsideCounsel?: string[] | null;
-    /** @nullable */
+    /**
+     * LITIGAT.INVESTIGATOR
+     * @nullable
+     */
     primaryInvestigator?: string | null;
-    /** @nullable */
+    /**
+     * MATTERSTAFF.STAFF_ID
+     * @nullable
+     */
     secondaryInvestigators?: string[] | null;
     /**
+     * LITIGAT.CAUSE
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     primaryCause?: string | null;
     /**
+     * LITIGAT.SECCAUSE1
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     secondaryCause1?: string | null;
     /**
+     * LITIGAT.SECCAUSE2
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     secondaryCause2?: string | null;
     /**
+     * LITIGAT.SECCAUSE3
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     secondaryCause3?: string | null;
     /**
+     * LITIGAT.SECCAUSE4
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     secondaryCause4?: string | null;
     /**
+     * LITIGAT.SECCAUSE5
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     secondaryCause5?: string | null;
     /**
+     * LITIGAT.COURT
      * @minLength 0
      * @maxLength 12
      * @nullable
      */
     court?: string | null;
     /**
+     * LITIGAT.COURT_NO
      * @minLength 0
      * @maxLength 30
      * @nullable
      */
     courtNumber?: string | null;
     /**
+     * LITIGAT.LOC_CODE
      * @minLength 0
      * @maxLength 20
      * @nullable
      */
     locationCode?: string | null;
     /**
+     * LITIGAT.SHORT_DESC
      * @minLength 0
      * @maxLength 90
      * @nullable
      */
     shortDescription?: string | null;
     /**
+     * LITIGAT.TRACK
      * @minLength 0
      * @maxLength 20
      * @nullable
      */
     track?: string | null;
     /**
+     * LITIGAT.PROBABILITY
      * @minLength 0
      * @maxLength 1
      * @nullable
      */
     probabilityReserve?: string | null;
     /**
+     * LITIGAT.MAXVALPROB
      * @minLength 0
      * @maxLength 1
      * @nullable
      */
     probabilityMaxValue?: string | null;
-    /** @nullable */
+    /**
+     * LITIGAT.FISCAL_YR
+     * @nullable
+     */
     fiscalYear?: number | null;
     /**
+     * LITIGAT.INS_TYPE
      * @minLength 0
      * @maxLength 6
      * @nullable
      */
     insuranceType?: string | null;
     /**
+     * LITIGAT.INS_GROUP
      * @minLength 0
      * @maxLength 20
      * @nullable
      */
     insuranceGroup?: string | null;
-    /** @nullable */
+    /**
+     * LITIGAT.PRAYER_AMT
+     * @nullable
+     */
     prayerAmount?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.MAX_VALUE
+     * @nullable
+     */
     maxValue?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.SETTLE_AMT
+     * @nullable
+     */
     expendituresSettlements?: number | null;
     /**
+     * LITIGAT.MAGISTRATE
      * @minLength 0
      * @maxLength 7
      * @nullable
      */
     magistrate?: string | null;
     /**
+     * LITIGAT.VENDOR
      * @minLength 0
      * @maxLength 7
      * @nullable
      */
     vendor?: string | null;
-    /** @nullable */
+    /**
+     * SqlAppointments.[Start]
+     * @nullable
+     */
     trialDate?: string | null;
-    /** @nullable */
+    /**
+     * LITIGAT.SETTLEDAMOUNT
+     * @nullable
+     */
     settledAmount?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.EXPENSE_AMT
+     * @nullable
+     */
     expendituresGeneral?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.CC_EXP_AMT
+     * @nullable
+     */
     expendituresContractCounsel?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.WITNESS_AMT
+     * @nullable
+     */
     expendituresExpertWitness?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.COLLECT_AMT
+     * @nullable
+     */
     collectionsCollected?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.PRREVENUE
+     * @nullable
+     */
     collectionsProjectedRevenue?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.IND_RSRV
+     * @nullable
+     */
     reservesIndemnity?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.EXP_RSRV
+     * @nullable
+     */
     reservesExpense?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.BALANCE
+     * @nullable
+     */
     balance?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.PAY_AMT
+     * @nullable
+     */
     payAmount?: number | null;
     /**
+     * LITIGAT.PAY_FREQ
      * @minLength 0
      * @maxLength 1
      * @nullable
      */
     payFrequency?: string | null;
-    /** @nullable */
+    /**
+     * LITIGAT.UDF1_AMT
+     * @nullable
+     */
     userDefinedAmount1?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.UDF2_AMT
+     * @nullable
+     */
     userDefinedAmount2?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.UDF3_AMT
+     * @nullable
+     */
     userDefinedAmount3?: number | null;
-    /** @nullable */
+    /**
+     * LITIGAT.UDF4_AMT
+     * @nullable
+     */
     userDefinedAmount4?: number | null;
+    /** LITIGAT.FM_DESTROY */
     fmDestroy?: boolean;
-    /** @nullable */
+    /**
+     * LITIGAT.FM_DESTROY_DT
+     * @nullable
+     */
     fmDestroyDate?: string | null;
     /**
+     * LITIGAT.FM_FILE_LOC
      * @minLength 0
      * @maxLength 20
      * @nullable
      */
     fileLocation?: string | null;
-    /** @nullable */
+    /**
+     * LITIGAT.FM_ARCHIVE_DT
+     * @nullable
+     */
     archiveDate?: string | null;
     /**
+     * LITIGAT.FM_ARCHIVE_BOX
      * @minLength 0
      * @maxLength 12
      * @nullable
      */
     archiveBox?: string | null;
     /**
+     * LITIGAT.FM_ARCHIVE_LOCATOR
      * @minLength 0
      * @maxLength 15
      * @nullable
      */
     archiveLocator?: string | null;
+    /**
+     * LITIGAT.HHSA
+     * @minLength 0
+     * @maxLength 15
+     * @nullable
+     */
+    hhsa?: string | null;
+    /**
+     * LITIGAT.APPEAL
+     * @minLength 0
+     * @maxLength 15
+     * @nullable
+     */
+    appeal?: string | null;
+    /**
+     * LITIGAT.ICWA
+     * @nullable
+     */
+    icwa?: boolean | null;
 }

package/dist/generated/models/litigationMatterDto.js

@@ -2,7 +2,16 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
 export {};

package/dist/generated/models/litigationSearchTermScopes.d.ts

@@ -2,9 +2,22 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
+/**
+ * The Search Term Scopes are used for indicating the fields
+within which to search for the Search Terms specified by the User.
+ */
 export interface LitigationSearchTermScopes {
     abstractDescription?: boolean;
     caption?: boolean;

package/dist/generated/models/litigationSearchTermScopes.js

@@ -2,7 +2,16 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
 export {};

package/dist/generated/models/markAveryLabelsPrintedRequest.d.ts

@@ -2,12 +2,32 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
+/**
+ * Request DTO for marking Avery label records as printed.
+ */
 export interface MarkAveryLabelsPrintedRequest {
-    /** @nullable */
+    /**
+     * One or more citation values to mark as printed.
+  When null, all citations are updated.
+     * @nullable
+     */
     citations?: string[] | null;
+    /** Number of blank label positions to skip before printing begins.
+  Must be greater than or equal to 0. */
     skipLabelCount?: number;
+    /** Number of copies of the selected labels to generate.
+  Must be between 1 and 100 inclusive. */
     copyCount?: number;
 }

package/dist/generated/models/markAveryLabelsPrintedRequest.js

@@ -2,7 +2,16 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
 export {};

package/dist/generated/models/matterAllegationDto.d.ts

@@ -2,7 +2,16 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
 export interface MatterAllegationDto {

package/dist/generated/models/matterAllegationDto.js

@@ -2,7 +2,16 @@
  * Generated by orval v7.17.0 🍺
  * Do not edit manually.
  * Mackinac API
- * Mackinac API - feature parity with Golden Gate
+ * Mackinac API - feature parity with Golden Gate.
+
+**Custom Forms conventions**
+
+- UUIDs are lowercase hyphenated strings.
+- Pagination is cursor-based: `?cursor={id}&limit={n}` (default 50, max 200).
+- Timestamps are ISO 8601 with offset.
+- Errors follow RFC 9457 `application/problem+json`.
+- Mutations to a form or any of its children (fields, elements, actions, rules) increment `FormDefinition.Version` and update `UpdatedAt`.
+- The Custom Forms model is product-agnostic: the consuming product owns auth, identity resolution, and AV scanning of uploaded files. Mackinac validates the identity contract and persists/executes submissions.
  * OpenAPI spec version: v1
  */
 export {};