@cycomdatasystems/mackinac-sdk 3.1.1 → 4.1.0

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { FormSubmissionActionDtoAction } from './formSubmissionActionDtoAction';
+import type { FormSubmissionActionDtoEmailBody } from './formSubmissionActionDtoEmailBody';
+export interface FormSubmissionActionDto {
+    id?: string;
+    formDefinitionId?: string;
+    /** @nullable */
+    action?: FormSubmissionActionDtoAction;
+    /** @nullable */
+    targetMatter?: string | null;
+    /** @nullable */
+    emailSubject?: string | null;
+    /** @nullable */
+    emailBody?: FormSubmissionActionDtoEmailBody;
+    /** @nullable */
+    emailRecipients?: string[] | null;
+    /** @nullable */
+    attachSubmissionCopy?: boolean | null;
+    /** @nullable */
+    matterFieldCode?: string | null;
+    /** @nullable */
+    derivedValue?: string | null;
+}

package/dist/generated/models/formSubmissionActionDto.js

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

package/dist/generated/models/formSubmissionActionDtoAction.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 FormSubmissionActionDtoAction = typeof FormSubmissionActionDtoAction[keyof typeof FormSubmissionActionDtoAction] | null;
+export declare const FormSubmissionActionDtoAction: {
+    readonly email: "email";
+    readonly 'create-as-matter': "create-as-matter";
+    readonly 'create-li-matter': "create-li-matter";
+    readonly 'create-note': "create-note";
+    readonly 'set-matter-field': "set-matter-field";
+    readonly 'add-submitter-contact': "add-submitter-contact";
+};

package/dist/generated/models/formSubmissionActionDtoAction.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 FormSubmissionActionDtoAction = {
+    email: 'email',
+    'create-as-matter': 'create-as-matter',
+    'create-li-matter': 'create-li-matter',
+    'create-note': 'create-note',
+    'set-matter-field': 'set-matter-field',
+    'add-submitter-contact': 'add-submitter-contact',
+};

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

@@ -0,0 +1,20 @@
+/**
+ * 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 FormSubmissionActionDtoEmailBody = unknown | null;

package/dist/generated/models/formSubmissionActionDtoEmailBody.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/formSubmissionActionDtoListResultDto.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 { FormSubmissionActionDto } from './formSubmissionActionDto';
+export interface FormSubmissionActionDtoListResultDto {
+    /** @nullable */
+    data?: FormSubmissionActionDto[] | null;
+}

package/dist/generated/models/formSubmissionActionDtoListResultDto.js

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

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

@@ -0,0 +1,33 @@
+/**
+ * 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 { FormSubmissionDtoSubmitterIdentityMode } from './formSubmissionDtoSubmitterIdentityMode';
+import type { FormSubmissionDtoFieldValues } from './formSubmissionDtoFieldValues';
+import type { ActionResultDto } from './actionResultDto';
+export interface FormSubmissionDto {
+    id?: string;
+    formDefinitionId?: string;
+    formVersion?: number;
+    submittedAt?: string;
+    /** @nullable */
+    submitterIdentityMode?: FormSubmissionDtoSubmitterIdentityMode;
+    /** @nullable */
+    submitterReference?: string | null;
+    /** @nullable */
+    fieldValues?: FormSubmissionDtoFieldValues;
+    /** @nullable */
+    actionResults?: ActionResultDto[] | null;
+}

package/dist/generated/models/formSubmissionDto.js

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

package/dist/generated/models/formSubmissionDtoCursorPagedResultDto.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 { FormSubmissionDto } from './formSubmissionDto';
+export interface FormSubmissionDtoCursorPagedResultDto {
+    /** @nullable */
+    data?: FormSubmissionDto[] | null;
+    /** @nullable */
+    cursor?: string | null;
+}

package/dist/generated/models/formSubmissionDtoCursorPagedResultDto.js

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

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

@@ -0,0 +1,20 @@
+/**
+ * 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 FormSubmissionDtoFieldValues = unknown | null;

package/dist/generated/models/formSubmissionDtoFieldValues.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/formSubmissionDtoSubmitterIdentityMode.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 FormSubmissionDtoSubmitterIdentityMode = typeof FormSubmissionDtoSubmitterIdentityMode[keyof typeof FormSubmissionDtoSubmitterIdentityMode] | null;
+export declare const FormSubmissionDtoSubmitterIdentityMode: {
+    readonly authenticated: "authenticated";
+    readonly 'email-required': "email-required";
+    readonly anonymous: "anonymous";
+};

package/dist/generated/models/formSubmissionDtoSubmitterIdentityMode.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 FormSubmissionDtoSubmitterIdentityMode = {
+    authenticated: 'authenticated',
+    'email-required': 'email-required',
+    anonymous: 'anonymous',
+};

package/dist/generated/models/generalExpenseDto.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 general expenses
+ */
 export interface GeneralExpenseDto {
     id?: number;
     /** @nullable */

package/dist/generated/models/generalExpenseDto.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/generalExpenseDtoPaginatedResultDto.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 { GeneralExpenseDto } from './generalExpenseDto';

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

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

@@ -2,10 +2,25 @@
  * 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 GetApiV1AllegationsDesiredOutcomesParams = {
+    /**
+     * Page number (default 1).
+     */
     pageNumber?: number;
+    /**
+     * Page size (default 10, max 50).
+     */
     pageSize?: number;
 };

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

@@ -2,10 +2,25 @@
  * 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 GetApiV1AllegationsIssueDetailsParams = {
+    /**
+     * Page number (default 1).
+     */
     pageNumber?: number;
+    /**
+     * Page size (default 10, max 50).
+     */
     pageSize?: number;
 };

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

@@ -2,10 +2,25 @@
  * 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 GetApiV1AllegationsIssuesParams = {
+    /**
+     * Page number (default 1).
+     */
     pageNumber?: number;
+    /**
+     * Page size (default 10, max 50).
+     */
     pageSize?: number;
 };

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

@@ -2,10 +2,25 @@
  * 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 GetApiV1AllegationsParams = {
+    /**
+     * Page number (default 1).
+     */
     pageNumber?: number;
+    /**
+     * Page size (default 10, max 50).
+     */
     pageSize?: number;
 };

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

@@ -2,10 +2,25 @@
  * 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 GetApiV1AllegationsStageDispositionsParams = {
+    /**
+     * Page number (default 1).
+     */
     pageNumber?: number;
+    /**
+     * Page size (default 10, max 50).
+     */
     pageSize?: number;
 };