@cycomdatasystems/mackinac-sdk 4.0.0 → 4.1.0

package/dist/generated/models/customAttributeTypedArgumentValue.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/deleteApiV1MattersMatterIdParams.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
  */
 export type DeleteApiV1MattersMatterIdParams = {
+    /**
+     * Whether to delete attachments associated with the matter. Required - must be explicitly provided.
+     */
     deleteAttachments?: boolean;
 };

package/dist/generated/models/deleteApiV1MattersMatterIdParams.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/eventAttributes.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 EventAttributes = typeof EventAttributes[keyof typeof EventAttributes];

package/dist/generated/models/eventAttributes.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/eventInfo.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 { Type } from './type';

package/dist/generated/models/exception.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 { MethodBase } from './methodBase';

package/dist/generated/models/exceptionData.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
  */
 /**

package/dist/generated/models/exceptionData.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/expenseReserveDto.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
  */
+/**
+ * Data transfer object for expense reserve entries
+ */
 export interface ExpenseReserveDto {
     id?: number;
     matterId?: number;
@@ -20,7 +32,10 @@ export interface ExpenseReserveDto {
     adjustmentAmount?: number | null;
     /** @nullable */
     totalAmount?: number | null;
-    /** @nullable */
+    /**
+     * The amount for this individual reserve payment
+     * @nullable
+     */
     amount?: number | null;
     /**
      * @minLength 0

package/dist/generated/models/expenseReserveDto.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/expenseReserveDtoPaginatedResultDto.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 { ExpenseReserveDto } from './expenseReserveDto';

package/dist/generated/models/expertWitnessDto.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
  */
+/**
+ * Data transfer object for expert witness payments
+ */
 export interface ExpertWitnessDto {
     id?: number;
     /** @nullable */

package/dist/generated/models/expertWitnessDto.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/expertWitnessDtoPaginatedResultDto.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 { ExpertWitnessDto } from './expertWitnessDto';

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

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

@@ -2,20 +2,34 @@
  * 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 { FieldDefinitionDtoInputType } from './fieldDefinitionDtoInputType';
+import type { FieldDefinitionDtoValueDestination } from './fieldDefinitionDtoValueDestination';
 export interface FieldDefinitionDto {
+    id?: string;
     /** @nullable */
-    fieldName: string | null;
+    label?: string | null;
     /** @nullable */
-    apiFieldName?: string | null;
+    name?: string | null;
     /** @nullable */
-    label?: string | null;
+    description?: string | null;
+    /** @nullable */
+    inputType?: FieldDefinitionDtoInputType;
     /** @nullable */
-    fieldType?: string | null;
+    valueDestination?: FieldDefinitionDtoValueDestination;
     /** @nullable */
-    isVisible?: boolean | null;
+    matterFieldCode?: string | null;
     /** @nullable */
-    optionsRef?: string | null;
+    selectOptions?: string[] | null;
 }

package/dist/generated/models/fieldDefinitionDto.js

@@ -1,8 +1 @@
-/**
- * Generated by orval v7.17.0 🍺
- * Do not edit manually.
- * Mackinac API
- * Mackinac API - feature parity with Golden Gate
- * OpenAPI spec version: v1
- */
 export {};

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

@@ -0,0 +1,23 @@
+/**
+ * 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 { FieldDefinitionDto } from './fieldDefinitionDto';
+export interface FieldDefinitionDtoCursorPagedResultDto {
+    /** @nullable */
+    data?: FieldDefinitionDto[] | null;
+    /** @nullable */
+    cursor?: string | null;
+}

package/dist/generated/models/fieldDefinitionDtoCursorPagedResultDto.js

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

package/dist/generated/models/fieldDefinitionDtoInputType.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
+ */
+/**
+ * @nullable
+ */
+export type FieldDefinitionDtoInputType = typeof FieldDefinitionDtoInputType[keyof typeof FieldDefinitionDtoInputType] | null;
+export declare const FieldDefinitionDtoInputType: {
+    readonly text: "text";
+    readonly number: "number";
+    readonly date: "date";
+    readonly select: "select";
+    readonly checkbox: "checkbox";
+    readonly file: "file";
+};

package/dist/generated/models/fieldDefinitionDtoInputType.js

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FieldDefinitionDtoInputType = {
+    text: 'text',
+    number: 'number',
+    date: 'date',
+    select: 'select',
+    checkbox: 'checkbox',
+    file: 'file',
+};

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

@@ -0,0 +1,25 @@
+/**
+ * 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
+ */
+/**
+ * @nullable
+ */
+export type FieldDefinitionDtoValueDestination = typeof FieldDefinitionDtoValueDestination[keyof typeof FieldDefinitionDtoValueDestination] | null;
+export declare const FieldDefinitionDtoValueDestination: {
+    readonly 'matter-field': "matter-field";
+    readonly 'matter-description': "matter-description";
+    readonly 'matter-note': "matter-note";
+};

package/dist/generated/models/fieldDefinitionDtoValueDestination.js

@@ -0,0 +1,22 @@
+/**
+ * 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
+ */
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const FieldDefinitionDtoValueDestination = {
+    'matter-field': 'matter-field',
+    'matter-description': 'matter-description',
+    'matter-note': 'matter-note',
+};

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

@@ -2,16 +2,43 @@
  * 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 purpose of this DTO is to represent a field
+with its custom label and value. This object is
+not concerned with visibility or selectable
+items.
+ */
 export interface FieldDto {
-    /** @nullable */
+    /**
+     * The field name.
+     * @nullable
+     */
     fieldName: string | null;
-    /** @nullable */
+    /**
+     * The custom label for the field.
+     * @nullable
+     */
     label: string | null;
-    /** @nullable */
+    /**
+     * The code value of the field.
+     * @nullable
+     */
     codeValue?: string | null;
-    /** @nullable */
+    /**
+     * The description of the code value.
+     * @nullable
+     */
     codeDescription?: string | null;
 }

package/dist/generated/models/fieldDto.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/fieldInfo.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 { Type } from './type';

package/dist/generated/models/fieldMetadataDto.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 { ISelectableItem } from './iSelectableItem';