@cycomdatasystems/mackinac-sdk 3.1.1 → 4.1.0

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

@@ -2,10 +2,23 @@
  * 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
  */
 import type { FieldMetadataDto } from './fieldMetadataDto';
+/**
+ * This DTO represents all the field metadata for a Matter, including
+field options, custom labels, and visibility.
+ */
 export interface MatterFieldMetadataDto {
     /** @nullable */
     fields: FieldMetadataDto[] | null;

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

@@ -2,14 +2,29 @@
  * 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
  */
 import type { MatterFieldMetadataV2DtoOptionSets } from './matterFieldMetadataV2DtoOptionSets';
-import type { FieldDefinitionDto } from './fieldDefinitionDto';
+import type { MatterFieldDefinitionDto } from './matterFieldDefinitionDto';
+/**
+ * v2 metadata shape. Selectable items are stored once in MackinacService.DTOs.MatterFieldMetadataV2Dto.OptionSets,
+keyed by a stable identifier. Each MackinacService.DTOs.MatterFieldDefinitionDto references its
+options by key via MackinacService.DTOs.MatterFieldDefinitionDto.OptionsRef rather than embedding
+the list inline, eliminating duplication for fields that share the same options pool.
+ */
 export interface MatterFieldMetadataV2Dto {
     /** @nullable */
     optionSets: MatterFieldMetadataV2DtoOptionSets;
     /** @nullable */
-    fields: FieldDefinitionDto[] | null;
+    fields: MatterFieldDefinitionDto[] | null;
 }

package/dist/generated/models/matterFieldMetadataV2DtoOptionSets.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
  */
 import type { SelectableItemDto } from './selectableItemDto';

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

@@ -0,0 +1,28 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * 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 MatterFieldRegistryDto {
+    /** @nullable */
+    code?: string | null;
+    /** @nullable */
+    label?: string | null;
+    /** @nullable */
+    description?: string | null;
+    /** @nullable */
+    fieldType?: string | null;
+    /** @nullable */
+    moduleCode?: string | null;
+}

package/dist/generated/models/matterFieldRegistryDto.js

@@ -0,0 +1,17 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * 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/matterFieldRegistryDtoListResultDto.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v7.17.0 🍺
+ * Do not edit manually.
+ * Mackinac API
+ * 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
+ */
+import type { MatterFieldRegistryDto } from './matterFieldRegistryDto';
+export interface MatterFieldRegistryDtoListResultDto {
+    /** @nullable */
+    data?: MatterFieldRegistryDto[] | null;
+}

package/dist/generated/models/matterFieldRegistryDtoListResultDto.js

@@ -0,0 +1 @@
+export {};

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

@@ -2,10 +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
  */
 import type { FieldDto } from './fieldDto';
+/**
+ * Finance field values for a Matter.
+ */
 export interface MatterFinanceFieldValuesDto {
     matterId?: number;
     /** @nullable */
@@ -14,7 +26,10 @@ export interface MatterFinanceFieldValuesDto {
     prayerAmount?: number | null;
     /** @nullable */
     maxValue?: number | null;
-    /** @nullable */
+    /**
+     * Stored as int in DB; exposed as string per contract.
+     * @nullable
+     */
     fiscalYear?: string | null;
     /** @nullable */
     insuranceGroup?: string | null;
@@ -42,6 +57,9 @@ export interface MatterFinanceFieldValuesDto {
     expendituresContractCounsel?: number | null;
     /** @nullable */
     expendituresSettlements?: number | null;
-    /** @nullable */
+    /**
+     * Selected fields (InsuranceGroup, ProbabilityMaxValue, ProbabilityReserve) with labels.
+     * @nullable
+     */
     fields?: FieldDto[] | null;
 }

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

@@ -2,10 +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
  */
 import type { FieldMetadataDto } from './fieldMetadataDto';
+/**
+ * Consolidated metadata for Matter Finance summary tab fields.
+ */
 export interface MatterFinanceMetadataDto {
     /** @nullable */
     fields: FieldMetadataDto[] | null;

package/dist/generated/models/matterFinancePatchDto.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
  */
+/**
+ * Patch DTO for Matter Finance updates. Nullable properties indicate optional update; SetNull flags clear values.
+Works for both Litigation (default) and Assignment module (AS) based on Matter base record.
+ */
 export interface MatterFinancePatchDto {
     /** @nullable */
     settledAmount?: number | null;

package/dist/generated/models/matterFinancePatchDto.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/matterPartyPatchDto.d.ts

@@ -2,9 +2,21 @@
  * 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
  */
+/**
+ * Represents a PATCH operation on a Primary Party, Witness, or Contact on a Matter.
+ */
 export interface MatterPartyPatchDto {
     id?: number;
     /**

package/dist/generated/models/matterPartyPatchDto.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/matterPartyPostDto.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 MatterPartyPostDto {

package/dist/generated/models/matterPartyPostDto.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/matterPartyRelationPatchDto.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 MatterPartyRelationPatchDto {

package/dist/generated/models/matterPartyRelationPatchDto.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/matterPaymentMetadataDto.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
  */
 import type { FieldMetadataDto } from './fieldMetadataDto';

package/dist/generated/models/matterPersonDto.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
  */
 import type { MatterPersonRelationDto } from './matterPersonRelationDto';

package/dist/generated/models/matterPersonRelationDto.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 MatterPersonRelationDto {

package/dist/generated/models/matterPersonRelationDto.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/matterSearchCriteriaDto.d.ts

@@ -2,10 +2,23 @@
  * 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
  */
 import type { LitigationSearchTermScopes } from './litigationSearchTermScopes';
+/**
+ * Represents the criteria for searching Matters in CityLaw / CountyLaw NG.
+This DTO is used to transfer search parameters from the client to the server.
+ */
 export interface MatterSearchCriteriaDto {
     openDateIsNull?: boolean;
     statusCodesIncludeFalsy?: boolean;

package/dist/generated/models/matterSearchHitsRequestDto.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
  */
+/**
+ * Represents the body of a POST request to get more hits
+from a previous Matter Search.
+ */
 export interface MatterSearchHitsRequestDto {
     /** @nullable */
     moduleCodes: string[] | null;

package/dist/generated/models/matterSearchHitsRequestDto.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/matterSearchRequestDto.d.ts

@@ -2,10 +2,23 @@
  * 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
  */
 import type { MatterSearchCriteriaDto } from './matterSearchCriteriaDto';
+/**
+ * Represents the body of a POST request to perform a Matter Search
+and obtain the first page of hits.
+ */
 export interface MatterSearchRequestDto {
     searchCriteria: MatterSearchCriteriaDto;
     /** @nullable */

package/dist/generated/models/memberInfo.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
  */
 import type { MemberTypes } from './memberTypes';

package/dist/generated/models/memberTypes.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 type MemberTypes = typeof MemberTypes[keyof typeof MemberTypes];

package/dist/generated/models/memberTypes.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
  */
 // eslint-disable-next-line @typescript-eslint/no-redeclare

package/dist/generated/models/methodAttributes.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 type MethodAttributes = typeof MethodAttributes[keyof typeof MethodAttributes];

package/dist/generated/models/methodAttributes.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
  */
 // eslint-disable-next-line @typescript-eslint/no-redeclare