@cycomdatasystems/mackinac-sdk 4.1.0 → 5.1.1

package/dist/generated/mackinac.client.js

@@ -1,4 +1,7 @@
 import { customFetch } from '../core/customFetch';
+/**
+ * @summary Get a paginated list of allegation definitions.
+ */
 export const getGetApiV1AllegationsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -15,6 +18,9 @@ export const getApiV1Allegations = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new allegation definition.
+ */
 export const getPostApiV1AllegationsUrl = () => {
     return `/api/v1/allegations`;
 };
@@ -26,6 +32,9 @@ export const postApiV1Allegations = async (createAllegationDto, options) => {
         body: JSON.stringify(createAllegationDto)
     });
 };
+/**
+ * @summary Get a single allegation definition by ID.
+ */
 export const getGetApiV1AllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/allegations/${allegationId}`;
 };
@@ -35,6 +44,9 @@ export const getApiV1AllegationsAllegationId = async (allegationId, options) =>
         method: 'GET'
     });
 };
+/**
+ * @summary Update an allegation definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/allegations/${allegationId}`;
 };
@@ -46,6 +58,9 @@ export const patchApiV1AllegationsAllegationId = async (allegationId, operation,
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an allegation definition.
+ */
 export const getDeleteApiV1AllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/allegations/${allegationId}`;
 };
@@ -55,6 +70,9 @@ export const deleteApiV1AllegationsAllegationId = async (allegationId, options)
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of allegation stage definitions.
+ */
 export const getGetApiV1AllegationsStagesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -71,6 +89,9 @@ export const getApiV1AllegationsStages = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new stage definition.
+ */
 export const getPostApiV1AllegationsStagesUrl = () => {
     return `/api/v1/allegations/stages`;
 };
@@ -82,6 +103,9 @@ export const postApiV1AllegationsStages = async (createAllegationStageDto, optio
         body: JSON.stringify(createAllegationStageDto)
     });
 };
+/**
+ * @summary Get a single stage definition by ID.
+ */
 export const getGetApiV1AllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/allegations/stages/${stageId}`;
 };
@@ -91,6 +115,9 @@ export const getApiV1AllegationsStagesStageId = async (stageId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Update a stage definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/allegations/stages/${stageId}`;
 };
@@ -102,6 +129,9 @@ export const patchApiV1AllegationsStagesStageId = async (stageId, operation, opt
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a stage definition.
+ */
 export const getDeleteApiV1AllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/allegations/stages/${stageId}`;
 };
@@ -111,6 +141,9 @@ export const deleteApiV1AllegationsStagesStageId = async (stageId, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of allegation sub-code definitions.
+ */
 export const getGetApiV1AllegationsSubcodesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -127,6 +160,9 @@ export const getApiV1AllegationsSubcodes = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new allegation sub-code definition.
+ */
 export const getPostApiV1AllegationsSubcodesUrl = () => {
     return `/api/v1/allegations/subcodes`;
 };
@@ -138,6 +174,9 @@ export const postApiV1AllegationsSubcodes = async (createAllegationSubCodeDto, o
         body: JSON.stringify(createAllegationSubCodeDto)
     });
 };
+/**
+ * @summary Get a single sub-code definition by ID.
+ */
 export const getGetApiV1AllegationsSubcodesSubCodeIdUrl = (subCodeId) => {
     return `/api/v1/allegations/subcodes/${subCodeId}`;
 };
@@ -147,6 +186,9 @@ export const getApiV1AllegationsSubcodesSubCodeId = async (subCodeId, options) =
         method: 'GET'
     });
 };
+/**
+ * @summary Update a sub-code definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsSubcodesSubCodeIdUrl = (subCodeId) => {
     return `/api/v1/allegations/subcodes/${subCodeId}`;
 };
@@ -158,6 +200,9 @@ export const patchApiV1AllegationsSubcodesSubCodeId = async (subCodeId, operatio
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a sub-code definition.
+ */
 export const getDeleteApiV1AllegationsSubcodesSubCodeIdUrl = (subCodeId) => {
     return `/api/v1/allegations/subcodes/${subCodeId}`;
 };
@@ -167,6 +212,9 @@ export const deleteApiV1AllegationsSubcodesSubCodeId = async (subCodeId, options
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of allegation issue definitions.
+ */
 export const getGetApiV1AllegationsIssuesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -183,6 +231,9 @@ export const getApiV1AllegationsIssues = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new allegation issue definition.
+ */
 export const getPostApiV1AllegationsIssuesUrl = () => {
     return `/api/v1/allegations/issues`;
 };
@@ -194,6 +245,9 @@ export const postApiV1AllegationsIssues = async (createAllegationIssueDto, optio
         body: JSON.stringify(createAllegationIssueDto)
     });
 };
+/**
+ * @summary Get a single issue definition by ID.
+ */
 export const getGetApiV1AllegationsIssuesIssueIdUrl = (issueId) => {
     return `/api/v1/allegations/issues/${issueId}`;
 };
@@ -203,6 +257,9 @@ export const getApiV1AllegationsIssuesIssueId = async (issueId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Update an issue definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsIssuesIssueIdUrl = (issueId) => {
     return `/api/v1/allegations/issues/${issueId}`;
 };
@@ -214,6 +271,9 @@ export const patchApiV1AllegationsIssuesIssueId = async (issueId, operation, opt
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an issue definition.
+ */
 export const getDeleteApiV1AllegationsIssuesIssueIdUrl = (issueId) => {
     return `/api/v1/allegations/issues/${issueId}`;
 };
@@ -223,6 +283,9 @@ export const deleteApiV1AllegationsIssuesIssueId = async (issueId, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of allegation issue detail definitions.
+ */
 export const getGetApiV1AllegationsIssueDetailsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -239,6 +302,9 @@ export const getApiV1AllegationsIssueDetails = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new allegation issue detail definition.
+ */
 export const getPostApiV1AllegationsIssueDetailsUrl = () => {
     return `/api/v1/allegations/issue-details`;
 };
@@ -250,6 +316,9 @@ export const postApiV1AllegationsIssueDetails = async (createAllegationIssueDeta
         body: JSON.stringify(createAllegationIssueDetailsDto)
     });
 };
+/**
+ * @summary Get a single issue detail definition by ID.
+ */
 export const getGetApiV1AllegationsIssueDetailsDetailIdUrl = (detailId) => {
     return `/api/v1/allegations/issue-details/${detailId}`;
 };
@@ -259,6 +328,9 @@ export const getApiV1AllegationsIssueDetailsDetailId = async (detailId, options)
         method: 'GET'
     });
 };
+/**
+ * @summary Update an issue detail definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsIssueDetailsDetailIdUrl = (detailId) => {
     return `/api/v1/allegations/issue-details/${detailId}`;
 };
@@ -270,6 +342,9 @@ export const patchApiV1AllegationsIssueDetailsDetailId = async (detailId, operat
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an issue detail definition.
+ */
 export const getDeleteApiV1AllegationsIssueDetailsDetailIdUrl = (detailId) => {
     return `/api/v1/allegations/issue-details/${detailId}`;
 };
@@ -279,6 +354,9 @@ export const deleteApiV1AllegationsIssueDetailsDetailId = async (detailId, optio
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of allegation stage disposition definitions (global list).
+ */
 export const getGetApiV1AllegationsStageDispositionsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -295,6 +373,9 @@ export const getApiV1AllegationsStageDispositions = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new stage disposition definition.
+ */
 export const getPostApiV1AllegationsStageDispositionsUrl = () => {
     return `/api/v1/allegations/stage-dispositions`;
 };
@@ -306,6 +387,9 @@ export const postApiV1AllegationsStageDispositions = async (createAllegationStag
         body: JSON.stringify(createAllegationStageDispositionDto)
     });
 };
+/**
+ * @summary Get a single stage disposition definition by ID.
+ */
 export const getGetApiV1AllegationsStageDispositionsDispositionIdUrl = (dispositionId) => {
     return `/api/v1/allegations/stage-dispositions/${dispositionId}`;
 };
@@ -315,6 +399,9 @@ export const getApiV1AllegationsStageDispositionsDispositionId = async (disposit
         method: 'GET'
     });
 };
+/**
+ * @summary Update a stage disposition definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsStageDispositionsDispositionIdUrl = (dispositionId) => {
     return `/api/v1/allegations/stage-dispositions/${dispositionId}`;
 };
@@ -326,6 +413,9 @@ export const patchApiV1AllegationsStageDispositionsDispositionId = async (dispos
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a stage disposition definition.
+ */
 export const getDeleteApiV1AllegationsStageDispositionsDispositionIdUrl = (dispositionId) => {
     return `/api/v1/allegations/stage-dispositions/${dispositionId}`;
 };
@@ -335,6 +425,9 @@ export const deleteApiV1AllegationsStageDispositionsDispositionId = async (dispo
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of stage disposition mappings for a given stage code.
+ */
 export const getGetApiV1AllegationsStagesDispositionMappingsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -351,6 +444,9 @@ export const getApiV1AllegationsStagesDispositionMappings = async (params, optio
         method: 'GET'
     });
 };
+/**
+ * @summary Get a single stage disposition mapping by ID.
+ */
 export const getGetApiV1AllegationsStagesDispositionMappingsMappingIdUrl = (mappingId) => {
     return `/api/v1/allegations/stages/disposition-mappings/${mappingId}`;
 };
@@ -360,6 +456,9 @@ export const getApiV1AllegationsStagesDispositionMappingsMappingId = async (mapp
         method: 'GET'
     });
 };
+/**
+ * @summary Update a stage disposition mapping using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsStagesDispositionMappingsMappingIdUrl = (mappingId) => {
     return `/api/v1/allegations/stages/disposition-mappings/${mappingId}`;
 };
@@ -371,6 +470,9 @@ export const patchApiV1AllegationsStagesDispositionMappingsMappingId = async (ma
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a stage disposition mapping.
+ */
 export const getDeleteApiV1AllegationsStagesDispositionMappingsMappingIdUrl = (mappingId) => {
     return `/api/v1/allegations/stages/disposition-mappings/${mappingId}`;
 };
@@ -380,6 +482,9 @@ export const deleteApiV1AllegationsStagesDispositionMappingsMappingId = async (m
         method: 'DELETE'
     });
 };
+/**
+ * @summary Create a new stage disposition mapping for a stage definition.
+ */
 export const getPostApiV1AllegationsStagesStageIdDispositionMappingsUrl = (stageId) => {
     return `/api/v1/allegations/stages/${stageId}/disposition-mappings`;
 };
@@ -391,6 +496,9 @@ export const postApiV1AllegationsStagesStageIdDispositionMappings = async (stage
         body: JSON.stringify(createStageDispositionMappingDto)
     });
 };
+/**
+ * @summary Get a paginated list of desired outcome definitions.
+ */
 export const getGetApiV1AllegationsDesiredOutcomesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -407,6 +515,9 @@ export const getApiV1AllegationsDesiredOutcomes = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new desired outcome definition.
+ */
 export const getPostApiV1AllegationsDesiredOutcomesUrl = () => {
     return `/api/v1/allegations/desired-outcomes`;
 };
@@ -418,6 +529,9 @@ export const postApiV1AllegationsDesiredOutcomes = async (createAllegationDesire
         body: JSON.stringify(createAllegationDesiredOutcomeDto)
     });
 };
+/**
+ * @summary Get a single desired outcome definition by ID.
+ */
 export const getGetApiV1AllegationsDesiredOutcomesOutcomeIdUrl = (outcomeId) => {
     return `/api/v1/allegations/desired-outcomes/${outcomeId}`;
 };
@@ -427,6 +541,9 @@ export const getApiV1AllegationsDesiredOutcomesOutcomeId = async (outcomeId, opt
         method: 'GET'
     });
 };
+/**
+ * @summary Update a desired outcome definition using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1AllegationsDesiredOutcomesOutcomeIdUrl = (outcomeId) => {
     return `/api/v1/allegations/desired-outcomes/${outcomeId}`;
 };
@@ -438,6 +555,9 @@ export const patchApiV1AllegationsDesiredOutcomesOutcomeId = async (outcomeId, o
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a desired outcome definition.
+ */
 export const getDeleteApiV1AllegationsDesiredOutcomesOutcomeIdUrl = (outcomeId) => {
     return `/api/v1/allegations/desired-outcomes/${outcomeId}`;
 };
@@ -447,6 +567,10 @@ export const deleteApiV1AllegationsDesiredOutcomesOutcomeId = async (outcomeId,
         method: 'DELETE'
     });
 };
+/**
+ * @summary Creates an attachment from a document template with token replacement.
+Per §3.2, §4.1, and §6 of the document template specification.
+ */
 export const getPostApiV1MattersMatterIdAttachmentsFromTemplateUrl = (matterId) => {
     return `/api/v1/matters/${matterId}/attachments/from-template`;
 };
@@ -456,6 +580,9 @@ export const postApiV1MattersMatterIdAttachmentsFromTemplate = async (matterId,
         method: 'POST'
     });
 };
+/**
+ * @summary Marks Avery label records as printed for the supplied citations.
+ */
 export const getPostApiV1AveryLabelsPrintedRecordsUrl = () => {
     return `/api/v1/avery-labels/printed-records`;
 };
@@ -467,6 +594,9 @@ export const postApiV1AveryLabelsPrintedRecords = async (markAveryLabelsPrintedR
         body: JSON.stringify(markAveryLabelsPrintedRequest)
     });
 };
+/**
+ * @summary Adds a new codeDto to the system.
+ */
 export const getPostApiV1CodesUrl = () => {
     return `/api/v1/Codes`;
 };
@@ -478,6 +608,9 @@ export const postApiV1Codes = async (codeDto, options) => {
         body: JSON.stringify(codeDto)
     });
 };
+/**
+ * @summary Retrieves a list of codes filtered by type and status.
+ */
 export const getGetApiV1CodesUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -494,6 +627,9 @@ export const getApiV1Codes = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Deletes a codeDto from the system by its ID.
+ */
 export const getDeleteApiV1CodesIdUrl = (id) => {
     return `/api/v1/Codes/${id}`;
 };
@@ -503,6 +639,9 @@ export const deleteApiV1CodesId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Retrieves a codeDto by its ID.
+ */
 export const getGetApiV1CodesIdUrl = (id) => {
     return `/api/v1/Codes/${id}`;
 };
@@ -512,6 +651,9 @@ export const getApiV1CodesId = async (id, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Applies a JSON Patch document to a CodeDto object.
+ */
 export const getPatchApiV1CodesIdUrl = (id) => {
     return `/api/v1/Codes/${id}`;
 };
@@ -523,6 +665,12 @@ export const patchApiV1CodesId = async (id, operation, options) => {
         body: JSON.stringify(operation)
     });
 };
+/**
+ * Returns the global field library. Supports `inputType` and `search`
+filters. Field definitions are reusable across forms — instantiate one on a
+form via `POST /form-definitions/{formId}/fields`.
+ * @summary List field definitions
+ */
 export const getGetApiV1FieldDefinitionsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -539,6 +687,16 @@ export const getApiV1FieldDefinitions = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * Creates a new entry in the global field library. Enforces all Field Definition
+validation rules from the schema doc: `matter-field` requires
+`matterFieldCode`; non-`matter-field` destinations forbid it;
+`select` requires `selectOptions` unless
+`valueDestination = matter-field` (in which case options are derived from
+the registry); file fields forbid `valueDestination`; `matterFieldCode`
+must exist in the Matter Field Registry.
+ * @summary Create a field definition
+ */
 export const getPostApiV1FieldDefinitionsUrl = () => {
     return `/api/v1/field-definitions`;
 };
@@ -550,6 +708,10 @@ export const postApiV1FieldDefinitions = async (createUpdateFieldDefinitionDto,
         body: JSON.stringify(createUpdateFieldDefinitionDto)
     });
 };
+/**
+ * Returns a single field definition by ID.
+ * @summary Get a field definition
+ */
 export const getGetApiV1FieldDefinitionsIdUrl = (id) => {
     return `/api/v1/field-definitions/${id}`;
 };
@@ -559,6 +721,13 @@ export const getApiV1FieldDefinitionsId = async (id, options) => {
         method: 'GET'
     });
 };
+/**
+ * Full replacement update. Applies the same validation as `POST`. Note
+that mutating a field definition affects every form that references it —
+clients should consider creating a new definition rather than editing one
+already in wide use.
+ * @summary Replace a field definition
+ */
 export const getPutApiV1FieldDefinitionsIdUrl = (id) => {
     return `/api/v1/field-definitions/${id}`;
 };
@@ -570,6 +739,11 @@ export const putApiV1FieldDefinitionsId = async (id, createUpdateFieldDefinition
         body: JSON.stringify(createUpdateFieldDefinitionDto)
     });
 };
+/**
+ * Returns `409 Conflict` if any `FormField` references this
+definition. Detach the definition from all forms before deleting.
+ * @summary Delete a field definition
+ */
 export const getDeleteApiV1FieldDefinitionsIdUrl = (id) => {
     return `/api/v1/field-definitions/${id}`;
 };
@@ -579,6 +753,11 @@ export const deleteApiV1FieldDefinitionsId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * Returns form metadata (no children). Supports `search` filter and
+cursor pagination.
+ * @summary List form definitions
+ */
 export const getGetApiV1FormDefinitionsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -595,6 +774,14 @@ export const getApiV1FormDefinitions = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * Creates an empty form with `version = 1` and an empty layout.
+`submitterIdentity` defaults to `email-required` if omitted; choose
+`authenticated` or `anonymous` only with intent — `anonymous`
+forms cannot use `add-submitter-contact` actions or
+`derivedValue = submitter`.
+ * @summary Create a form definition
+ */
 export const getPostApiV1FormDefinitionsUrl = () => {
     return `/api/v1/form-definitions`;
 };
@@ -606,6 +793,12 @@ export const postApiV1FormDefinitions = async (createFormDefinitionDto, options)
         body: JSON.stringify(createFormDefinitionDto)
     });
 };
+/**
+ * Returns the form's top-level record including its `layout`. Does not
+expand children — use `GET /form-definitions/{id}/full` for a
+fully-hydrated form, or the child collection endpoints for individual lists.
+ * @summary Get a form definition
+ */
 export const getGetApiV1FormDefinitionsIdUrl = (id) => {
     return `/api/v1/form-definitions/${id}`;
 };
@@ -615,6 +808,16 @@ export const getApiV1FormDefinitionsId = async (id, options) => {
         method: 'GET'
     });
 };
+/**
+ * Updates name, description, `submitterIdentity`, and `layout`.
+Increments `version` and updates `updatedAt`. Enforces all Layout
+validation rules (every form field and element must appear in the layout
+exactly once; ids must belong to this form; `type` must match the
+referenced entity; `colSpan` must be 1–12) and the cross-table save-time
+rules (e.g. `add-submitter-contact` invalid when switching to
+`anonymous`).
+ * @summary Update a form definition
+ */
 export const getPutApiV1FormDefinitionsIdUrl = (id) => {
     return `/api/v1/form-definitions/${id}`;
 };
@@ -626,6 +829,13 @@ export const putApiV1FormDefinitionsId = async (id, updateFormDefinitionDto, opt
         body: JSON.stringify(updateFormDefinitionDto)
     });
 };
+/**
+ * Cascades to all child records: fields, elements, actions, rules, and
+submissions. Retention policy for `FormSubmission` records is not
+defined by this API — consuming products should archive submission data
+before deletion if needed.
+ * @summary Delete a form definition
+ */
 export const getDeleteApiV1FormDefinitionsIdUrl = (id) => {
     return `/api/v1/form-definitions/${id}`;
 };
@@ -635,6 +845,13 @@ export const deleteApiV1FormDefinitionsId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * Returns the form definition with `fields`, `elements`,
+`actions`, and `rules` inlined. Intended for the form builder UI
+and rendering engines that need a complete picture in one request. Prefer
+the individual child endpoints when only one child collection is needed.
+ * @summary Get a form with all children expanded
+ */
 export const getGetApiV1FormDefinitionsIdFullUrl = (id) => {
     return `/api/v1/form-definitions/${id}/full`;
 };
@@ -644,6 +861,12 @@ export const getApiV1FormDefinitionsIdFull = async (id, options) => {
         method: 'GET'
     });
 };
+/**
+ * Returns the static content elements (headers, markdown blocks, cards) on
+the form. Order is determined by the form's `layout`, not by this
+list.
+ * @summary List form elements
+ */
 export const getGetApiV1FormDefinitionsFormIdElementsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/elements`;
 };
@@ -653,6 +876,14 @@ export const getApiV1FormDefinitionsFormIdElements = async (formId, options) =>
         method: 'GET'
     });
 };
+/**
+ * Creates a static content element. `header` elements require
+`headerRank` (1–4); `card` elements may carry `cardIcon`
+(`info`, `warning`, `important`); `markdown` and
+`card` elements support Markdown in `text`. Increments the form's
+`version`.
+ * @summary Add an element to a form
+ */
 export const getPostApiV1FormDefinitionsFormIdElementsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/elements`;
 };
@@ -664,6 +895,11 @@ export const postApiV1FormDefinitionsFormIdElements = async (formId, createUpdat
         body: JSON.stringify(createUpdateFormElementDto)
     });
 };
+/**
+ * Updates element content and presentation. Applies the same per-type
+constraints as `POST`. Increments the form's `version`.
+ * @summary Update a form element
+ */
 export const getPutApiV1FormDefinitionsFormIdElementsElementIdUrl = (formId, elementId) => {
     return `/api/v1/form-definitions/${formId}/elements/${elementId}`;
 };
@@ -675,6 +911,11 @@ export const putApiV1FormDefinitionsFormIdElementsElementId = async (formId, ele
         body: JSON.stringify(createUpdateFormElementDto)
     });
 };
+/**
+ * Removes the element from `layout` and cascades to any rules targeting
+it. Increments the form's `version`.
+ * @summary Remove an element from a form
+ */
 export const getDeleteApiV1FormDefinitionsFormIdElementsElementIdUrl = (formId, elementId) => {
     return `/api/v1/form-definitions/${formId}/elements/${elementId}`;
 };
@@ -684,6 +925,11 @@ export const deleteApiV1FormDefinitionsFormIdElementsElementId = async (formId,
         method: 'DELETE'
     });
 };
+/**
+ * Returns all rules on the form. Optionally filter by
+`sourceFormFieldId` to fetch only rules driven by a specific field.
+ * @summary List conditional rules
+ */
 export const getGetApiV1FormDefinitionsFormIdRulesUrl = (formId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -700,6 +946,16 @@ export const getApiV1FormDefinitionsFormIdRules = async (formId, params, options
         method: 'GET'
     });
 };
+/**
+ * Creates a rule that applies an effect to a target field or element when the
+source field's value matches `triggerValue`. Enforces effect/target-type
+compatibility (field-only effects vs element-only effects), same-form
+constraint on source and target, and `setValue` non-null when
+`effect = set-value`. `set-value` may target a hidden field — this
+is the intended mechanism for populating Matter fields not exposed to the
+submitter. Increments the form's `version`.
+ * @summary Add a conditional rule
+ */
 export const getPostApiV1FormDefinitionsFormIdRulesUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/rules`;
 };
@@ -711,6 +967,11 @@ export const postApiV1FormDefinitionsFormIdRules = async (formId, createUpdateFo
         body: JSON.stringify(createUpdateFormFieldRuleDto)
     });
 };
+/**
+ * Updates rule configuration. Applies the same validation as `POST`.
+Increments the form's `version`.
+ * @summary Update a conditional rule
+ */
 export const getPutApiV1FormDefinitionsFormIdRulesRuleIdUrl = (formId, ruleId) => {
     return `/api/v1/form-definitions/${formId}/rules/${ruleId}`;
 };
@@ -722,6 +983,10 @@ export const putApiV1FormDefinitionsFormIdRulesRuleId = async (formId, ruleId, c
         body: JSON.stringify(createUpdateFormFieldRuleDto)
     });
 };
+/**
+ * Removes the rule. Does not affect the source field or target.
+ * @summary Delete a conditional rule
+ */
 export const getDeleteApiV1FormDefinitionsFormIdRulesRuleIdUrl = (formId, ruleId) => {
     return `/api/v1/form-definitions/${formId}/rules/${ruleId}`;
 };
@@ -731,6 +996,11 @@ export const deleteApiV1FormDefinitionsFormIdRulesRuleId = async (formId, ruleId
         method: 'DELETE'
     });
 };
+/**
+ * Returns all `FormField` instances on the form, each with its embedded
+`FieldDefinition`.
+ * @summary List form fields
+ */
 export const getGetApiV1FormDefinitionsFormIdFieldsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/fields`;
 };
@@ -740,6 +1010,19 @@ export const getApiV1FormDefinitionsFormIdFields = async (formId, options) => {
         method: 'GET'
     });
 };
+/**
+ * Instantiates a `FieldDefinition` on the form. Enforces all Form Field
+validation rules: file fields must set `attachToMatter` and
+`attachToEmailActionIds` and must route to at least one destination;
+`matter-note` fields must set `noteActionId` pointing to a
+`create-note` action on the same form; `attachToEmailActionIds`
+entries must reference email actions on the same form;
+`attachToMatter = true` requires a `create-*-matter` action on the
+form; module-scoped field definitions must match the form's target module.
+Increments the form's `version`. A given field definition may appear on
+a form at most once.
+ * @summary Add a field to a form
+ */
 export const getPostApiV1FormDefinitionsFormIdFieldsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/fields`;
 };
@@ -751,6 +1034,10 @@ export const postApiV1FormDefinitionsFormIdFields = async (formId, createUpdateF
         body: JSON.stringify(createUpdateFormFieldDto)
     });
 };
+/**
+ * Returns a single form field with its embedded field definition.
+ * @summary Get a form field
+ */
 export const getGetApiV1FormDefinitionsFormIdFieldsFieldIdUrl = (formId, fieldId) => {
     return `/api/v1/form-definitions/${formId}/fields/${fieldId}`;
 };
@@ -760,6 +1047,12 @@ export const getApiV1FormDefinitionsFormIdFieldsFieldId = async (formId, fieldId
         method: 'GET'
     });
 };
+/**
+ * Updates per-form configuration (`visible`, `required`, file
+routing, note routing). Applies the same validation as `POST`.
+Increments the form's `version`.
+ * @summary Update a form field
+ */
 export const getPutApiV1FormDefinitionsFormIdFieldsFieldIdUrl = (formId, fieldId) => {
     return `/api/v1/form-definitions/${formId}/fields/${fieldId}`;
 };
@@ -771,6 +1064,11 @@ export const putApiV1FormDefinitionsFormIdFieldsFieldId = async (formId, fieldId
         body: JSON.stringify(createUpdateFormFieldDto)
     });
 };
+/**
+ * Cascades to any `FormFieldRule` where this field is the source.
+Removes the field from `layout`. Increments the form's `version`.
+ * @summary Remove a field from a form
+ */
 export const getDeleteApiV1FormDefinitionsFormIdFieldsFieldIdUrl = (formId, fieldId) => {
     return `/api/v1/form-definitions/${formId}/fields/${fieldId}`;
 };
@@ -780,6 +1078,9 @@ export const deleteApiV1FormDefinitionsFormIdFieldsFieldId = async (formId, fiel
         method: 'DELETE'
     });
 };
+/**
+ * @summary Gets the layout configuration for the Create New Matter form for the specified module.
+ */
 export const getGetApiV1FormsCreateMatterModuleCodeUrl = (moduleCode) => {
     return `/api/v1/Forms/create-matter/${moduleCode}`;
 };
@@ -789,6 +1090,14 @@ export const getApiV1FormsCreateMatterModuleCode = async (moduleCode, options) =
         method: 'GET'
     });
 };
+/**
+ * Returns all actions configured to fire when the form is submitted.
+Field-driven actions (`create-note`, `create-*-matter`) interact
+with `FormField` routing; automatic actions (`email`,
+`set-matter-field`, `add-submitter-contact`) fire regardless of
+field input.
+ * @summary List submission actions
+ */
 export const getGetApiV1FormDefinitionsFormIdActionsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/actions`;
 };
@@ -798,6 +1107,18 @@ export const getApiV1FormDefinitionsFormIdActions = async (formId, options) => {
         method: 'GET'
     });
 };
+/**
+ * Creates a submission action. Enforces all Submission Action validation
+rules: `email` actions require `emailSubject`, `emailBody`,
+`emailRecipients`, and `attachSubmissionCopy`;
+`set-matter-field` requires `matterFieldCode` and
+`derivedValue`; `targetMatter = 'created-matter'` requires a
+sibling `create-*-matter` action on the same form; a form may have at
+most one `create-*-matter` action; `add-submitter-contact` and
+`derivedValue = submitter` are invalid on `anonymous` forms.
+Increments the form's `version`.
+ * @summary Add a submission action
+ */
 export const getPostApiV1FormDefinitionsFormIdActionsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/actions`;
 };
@@ -809,6 +1130,11 @@ export const postApiV1FormDefinitionsFormIdActions = async (formId, createUpdate
         body: JSON.stringify(createUpdateFormSubmissionActionDto)
     });
 };
+/**
+ * Updates action configuration. Applies the same validation as `POST`.
+Increments the form's `version`.
+ * @summary Update a submission action
+ */
 export const getPutApiV1FormDefinitionsFormIdActionsActionIdUrl = (formId, actionId) => {
     return `/api/v1/form-definitions/${formId}/actions/${actionId}`;
 };
@@ -820,6 +1146,12 @@ export const putApiV1FormDefinitionsFormIdActionsActionId = async (formId, actio
         body: JSON.stringify(createUpdateFormSubmissionActionDto)
     });
 };
+/**
+ * Returns `409 Conflict` if any `FormField.noteActionId` or
+`FormField.attachToEmailActionIds` references this action. Detach the
+field routing before deleting.
+ * @summary Remove a submission action
+ */
 export const getDeleteApiV1FormDefinitionsFormIdActionsActionIdUrl = (formId, actionId) => {
     return `/api/v1/form-definitions/${formId}/actions/${actionId}`;
 };
@@ -829,6 +1161,12 @@ export const deleteApiV1FormDefinitionsFormIdActionsActionId = async (formId, ac
         method: 'DELETE'
     });
 };
+/**
+ * Returns submissions ordered by `submittedAt`. Supports
+`submittedAfter` / `submittedBefore` date range filters and
+cursor pagination.
+ * @summary List submissions for a form
+ */
 export const getGetApiV1FormDefinitionsFormIdSubmissionsUrl = (formId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -845,6 +1183,18 @@ export const getApiV1FormDefinitionsFormIdSubmissions = async (formId, params, o
         method: 'GET'
     });
 };
+/**
+ * Submits a completed form. The consuming product resolves submitter identity
+(per the form's `submitterIdentity` contract) and AV-scans any
+uploaded files before calling this endpoint — Mackinac does neither.
+Mackinac validates that the submitted identity satisfies the form's
+contract, persists a `FormSubmission` record, executes all configured
+actions, and records outcomes in `actionResults`. File fields
+reference previously uploaded files by ID; inline file content is never
+sent. Platform limits of 10 files and 35 MB total per submission are
+enforced here.
+ * @summary Submit a form
+ */
 export const getPostApiV1FormDefinitionsFormIdSubmissionsUrl = (formId) => {
     return `/api/v1/form-definitions/${formId}/submissions`;
 };
@@ -856,6 +1206,11 @@ export const postApiV1FormDefinitionsFormIdSubmissions = async (formId, createFo
         body: JSON.stringify(createFormSubmissionDto)
     });
 };
+/**
+ * Returns a single submission record including `fieldValues` and
+`actionResults`.
+ * @summary Get a submission
+ */
 export const getGetApiV1FormDefinitionsFormIdSubmissionsSubmissionIdUrl = (formId, submissionId) => {
     return `/api/v1/form-definitions/${formId}/submissions/${submissionId}`;
 };
@@ -865,6 +1220,13 @@ export const getApiV1FormDefinitionsFormIdSubmissionsSubmissionId = async (formI
         method: 'GET'
     });
 };
+/**
+ * Re-executes only the actions with `status = failed` in
+`actionResults`, using the original `fieldValues` and
+`submitterReference`. Successful actions are not re-run. Updates
+`actionResults` in place.
+ * @summary Retry failed actions on a submission
+ */
 export const getPostApiV1FormDefinitionsFormIdSubmissionsSubmissionIdRetryUrl = (formId, submissionId) => {
     return `/api/v1/form-definitions/${formId}/submissions/${submissionId}/retry`;
 };
@@ -874,6 +1236,9 @@ export const postApiV1FormDefinitionsFormIdSubmissionsSubmissionIdRetry = async
         method: 'POST'
     });
 };
+/**
+ * @summary Get a paginated list of allegations for a matter.
+ */
 export const getGetApiV1MattersMatterIdAllegationsUrl = (matterId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -890,6 +1255,9 @@ export const getApiV1MattersMatterIdAllegations = async (matterId, params, optio
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new allegation on a matter.
+ */
 export const getPostApiV1MattersMatterIdAllegationsUrl = (matterId) => {
     return `/api/v1/matters/${matterId}/allegations`;
 };
@@ -901,6 +1269,9 @@ export const postApiV1MattersMatterIdAllegations = async (matterId, createMatter
         body: JSON.stringify(createMatterAllegationDto)
     });
 };
+/**
+ * @summary Get a paginated, filtered, sorted view of all allegation stages across a matter.
+ */
 export const getGetApiV1MattersMatterIdAllegationsStagesUrl = (matterId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -917,6 +1288,9 @@ export const getApiV1MattersMatterIdAllegationsStages = async (matterId, params,
         method: 'GET'
     });
 };
+/**
+ * @summary Get a single allegation by ID.
+ */
 export const getGetApiV1MattersAllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/matters/allegations/${allegationId}`;
 };
@@ -926,6 +1300,9 @@ export const getApiV1MattersAllegationsAllegationId = async (allegationId, optio
         method: 'GET'
     });
 };
+/**
+ * @summary Update an allegation using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1MattersAllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/matters/allegations/${allegationId}`;
 };
@@ -937,6 +1314,9 @@ export const patchApiV1MattersAllegationsAllegationId = async (allegationId, ope
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an allegation (cascade-deletes its stages).
+ */
 export const getDeleteApiV1MattersAllegationsAllegationIdUrl = (allegationId) => {
     return `/api/v1/matters/allegations/${allegationId}`;
 };
@@ -946,6 +1326,9 @@ export const deleteApiV1MattersAllegationsAllegationId = async (allegationId, op
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get a paginated list of stages for a specific allegation.
+ */
 export const getGetApiV1MattersAllegationsAllegationIdStagesUrl = (allegationId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -962,6 +1345,9 @@ export const getApiV1MattersAllegationsAllegationIdStages = async (allegationId,
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new stage on an allegation.
+ */
 export const getPostApiV1MattersAllegationsAllegationIdStagesUrl = (allegationId) => {
     return `/api/v1/matters/allegations/${allegationId}/stages`;
 };
@@ -973,6 +1359,9 @@ export const postApiV1MattersAllegationsAllegationIdStages = async (allegationId
         body: JSON.stringify(createMatterAllegationStageDto)
     });
 };
+/**
+ * @summary Get a single stage by ID.
+ */
 export const getGetApiV1MattersAllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/matters/allegations/stages/${stageId}`;
 };
@@ -982,6 +1371,9 @@ export const getApiV1MattersAllegationsStagesStageId = async (stageId, options)
         method: 'GET'
     });
 };
+/**
+ * @summary Update a stage using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1MattersAllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/matters/allegations/stages/${stageId}`;
 };
@@ -993,6 +1385,9 @@ export const patchApiV1MattersAllegationsStagesStageId = async (stageId, operati
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete a stage of an allegation.
+ */
 export const getDeleteApiV1MattersAllegationsStagesStageIdUrl = (stageId) => {
     return `/api/v1/matters/allegations/stages/${stageId}`;
 };
@@ -1002,6 +1397,14 @@ export const deleteApiV1MattersAllegationsStagesStageId = async (stageId, option
         method: 'DELETE'
     });
 };
+/**
+ * Returns all entries in the platform-maintained registry of Matter fields that
+`FieldDefinition` and `FormSubmissionAction` records can target.
+Supports `moduleCode` filtering so the form builder can scope picker
+contents to a specific module — universal entries, where `moduleCode` is
+null, are always returned.
+ * @summary List Matter field registry entries
+ */
 export const getGetApiV1MatterFieldRegistryUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1018,6 +1421,13 @@ export const getApiV1MatterFieldRegistry = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * Returns a single registry entry by its dot-notation `code`
+(e.g. `Matter.Title`). Used to resolve label and `fieldType` for
+validation when an entry is referenced from a `FieldDefinition` or
+`set-matter-field` action.
+ * @summary Get a Matter field registry entry
+ */
 export const getGetApiV1MatterFieldRegistryCodeUrl = (code) => {
     return `/api/v1/matter-field-registry/${code}`;
 };
@@ -1119,6 +1529,11 @@ export const getApiV1MattersMatterIdFinanceReservesExpensesId = async (matterId,
         method: 'GET'
     });
 };
+/**
+ * @summary Update an expense reserve entry.
+PATCH operations should target the 'Amount' field to update the per-payment amount.
+After the update, the matter's total ReservesExpense is recalculated as the sum of all expense reserve payments.
+ */
 export const getPatchApiV1MattersMatterIdFinanceReservesExpensesIdUrl = (matterId, id) => {
     return `/api/v1/matters/${matterId}/finance/reserves/expenses/${id}`;
 };
@@ -1130,6 +1545,10 @@ export const patchApiV1MattersMatterIdFinanceReservesExpensesId = async (matterI
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an expense reserve entry.
+After deletion, the matter's total ReservesExpense is recalculated as the sum of all remaining expense reserve payments.
+ */
 export const getDeleteApiV1MattersMatterIdFinanceReservesExpensesIdUrl = (matterId, id) => {
     return `/api/v1/matters/${matterId}/finance/reserves/expenses/${id}`;
 };
@@ -1168,6 +1587,11 @@ export const getApiV1MattersMatterIdFinanceReservesIndemnityId = async (matterId
         method: 'GET'
     });
 };
+/**
+ * @summary Update an indemnity reserve entry.
+PATCH operations should target the 'Amount' field to update the per-payment amount.
+After the update, the matter's total ReservesIndemnity is recalculated as the sum of all indemnity reserve payments.
+ */
 export const getPatchApiV1MattersMatterIdFinanceReservesIndemnityIdUrl = (matterId, id) => {
     return `/api/v1/matters/${matterId}/finance/reserves/indemnity/${id}`;
 };
@@ -1179,6 +1603,10 @@ export const patchApiV1MattersMatterIdFinanceReservesIndemnityId = async (matter
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an indemnity reserve entry.
+After deletion, the matter's total ReservesIndemnity is recalculated as the sum of all remaining indemnity reserve payments.
+ */
 export const getDeleteApiV1MattersMatterIdFinanceReservesIndemnityIdUrl = (matterId, id) => {
     return `/api/v1/matters/${matterId}/finance/reserves/indemnity/${id}`;
 };
@@ -1412,6 +1840,9 @@ export const deleteApiV1MattersMatterIdFinanceExpendituresContractCounselId = as
         method: 'DELETE'
     });
 };
+/**
+ * @summary Get field metadata for creating a Payment on a Matter.
+ */
 export const getGetApiV1MattersMatterIdFinancePaymentFieldMetadataUrl = (matterId) => {
     return `/api/v1/matters/${matterId}/finance/payment-field-metadata`;
 };
@@ -1437,7 +1868,6 @@ export const getApiV1MattersFileNumberExists = async (params, options) => {
         method: 'GET'
     });
 };
-;
 export const getGetApiV1MattersLitigationMatterIdUrl = (matterId) => {
     return `/api/v1/Matters/litigation/${matterId}`;
 };
@@ -1447,7 +1877,9 @@ export const getApiV1MattersLitigationMatterId = async (matterId, options) => {
         method: 'GET'
     });
 };
-;
+/**
+ * @deprecated
+ */
 export const getPatchApiV1MattersLitigationMatterIdUrl = (matterId) => {
     return `/api/v1/Matters/litigation/${matterId}`;
 };
@@ -1459,7 +1891,6 @@ export const patchApiV1MattersLitigationMatterId = async (matterId, litigationMa
         body: JSON.stringify(litigationMatterDto)
     });
 };
-;
 export const getGetApiV1MattersLitigationMatterIdAbstractUrl = (matterId) => {
     return `/api/v1/Matters/litigation/${matterId}/abstract`;
 };
@@ -1469,7 +1900,6 @@ export const getApiV1MattersLitigationMatterIdAbstract = async (matterId, option
         method: 'GET'
     });
 };
-;
 export const getPutApiV1MattersLitigationMatterIdAbstractUrl = (matterId) => {
     return `/api/v1/Matters/litigation/${matterId}/abstract`;
 };
@@ -1497,7 +1927,6 @@ export const getApiV1MattersFieldsMetadata = async (params, options) => {
         method: 'GET'
     });
 };
-;
 export const getGetApiV1MattersFieldsMetadataDepartmentUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1514,7 +1943,6 @@ export const getApiV1MattersFieldsMetadataDepartment = async (params, options) =
         method: 'GET'
     });
 };
-;
 export const getGetApiV1MattersFieldsMetadataAccountUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1531,7 +1959,6 @@ export const getApiV1MattersFieldsMetadataAccount = async (params, options) => {
         method: 'GET'
     });
 };
-;
 export const getGetApiV1MattersFieldsMetadataAbstractUrl = () => {
     return `/api/v1/Matters/fields/metadata/abstract`;
 };
@@ -1541,6 +1968,10 @@ export const getApiV1MattersFieldsMetadataAbstract = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Gets consolidated field metadata for creating a Matter in the specified module.
+This aggregation endpoint returns metadata for all fields needed to render the Create Matter form.
+ */
 export const getGetApiV1MattersFieldsMetadataCreateUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1557,7 +1988,9 @@ export const getApiV1MattersFieldsMetadataCreate = async (params, options) => {
         method: 'GET'
     });
 };
-;
+/**
+ * @summary Adds a new Note to a Matter.
+ */
 export const getPostApiV1MattersMatterIdNotesUrl = (matterId) => {
     return `/api/v1/Matters/${matterId}/notes`;
 };
@@ -1569,7 +2002,9 @@ export const postApiV1MattersMatterIdNotes = async (matterId, noteDto, options)
         body: JSON.stringify(noteDto)
     });
 };
-;
+/**
+ * @summary Get all the Notes on a given Matter without their content.
+ */
 export const getGetApiV1MattersMatterIdNotesUrl = (matterId) => {
     return `/api/v1/Matters/${matterId}/notes`;
 };
@@ -1579,7 +2014,9 @@ export const getApiV1MattersMatterIdNotes = async (matterId, options) => {
         method: 'GET'
     });
 };
-;
+/**
+ * @summary Updates an existing Note on a Matter, overwriting the existing Note.
+ */
 export const getPutApiV1MattersNotesNoteIdUrl = (noteId) => {
     return `/api/v1/Matters/notes/${noteId}`;
 };
@@ -1591,6 +2028,9 @@ export const putApiV1MattersNotesNoteId = async (noteId, noteDto, options) => {
         body: JSON.stringify(noteDto)
     });
 };
+/**
+ * @summary Get the content of a specific Note.
+ */
 export const getGetApiV1MattersNotesNoteIdUrl = (noteId) => {
     return `/api/v1/Matters/notes/${noteId}`;
 };
@@ -1600,6 +2040,9 @@ export const getApiV1MattersNotesNoteId = async (noteId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Deletes the Note with the given ID.
+ */
 export const getDeleteApiV1MattersNotesNoteIdUrl = (noteId) => {
     return `/api/v1/Matters/notes/${noteId}`;
 };
@@ -1609,6 +2052,9 @@ export const deleteApiV1MattersNotesNoteId = async (noteId, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Adds a new party to a matter.
+ */
 export const getPostApiV1MattersMatterIdPartiesUrl = (matterId) => {
     return `/api/v1/Matters/${matterId}/parties`;
 };
@@ -1620,6 +2066,10 @@ export const postApiV1MattersMatterIdParties = async (matterId, matterPartyPostD
         body: JSON.stringify(matterPartyPostDto)
     });
 };
+/**
+ * @summary Gets the Parties associated with the given Matter, including Related Parties
+for Primary Parties.
+ */
 export const getGetApiV1MattersMatterIdPartiesUrl = (matterId) => {
     return `/api/v1/Matters/${matterId}/parties`;
 };
@@ -1629,6 +2079,9 @@ export const getApiV1MattersMatterIdParties = async (matterId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Patches the given Matter Party.
+ */
 export const getPatchApiV1MattersPartiesIdUrl = (id) => {
     return `/api/v1/Matters/parties/${id}`;
 };
@@ -1640,6 +2093,9 @@ export const patchApiV1MattersPartiesId = async (id, matterPartyPatchDto, option
         body: JSON.stringify(matterPartyPatchDto)
     });
 };
+/**
+ * @summary Deletes the Party with the given ID from its Matter.
+ */
 export const getDeleteApiV1MattersPartiesIdUrl = (id) => {
     return `/api/v1/Matters/parties/${id}`;
 };
@@ -1649,6 +2105,9 @@ export const deleteApiV1MattersPartiesId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Adds a new Related Party to a Matter.
+ */
 export const getPostApiV1MattersMatterIdPartiesPartyIdRelatedUrl = (matterId, partyId) => {
     return `/api/v1/Matters/${matterId}/parties/${partyId}/related`;
 };
@@ -1660,6 +2119,9 @@ export const postApiV1MattersMatterIdPartiesPartyIdRelated = async (matterId, pa
         body: JSON.stringify(matterPersonRelationDto)
     });
 };
+/**
+ * @summary Patches the given Related Party on a Matter.
+ */
 export const getPatchApiV1MattersPartiesRelatedIdUrl = (id) => {
     return `/api/v1/Matters/parties/related/${id}`;
 };
@@ -1671,6 +2133,9 @@ export const patchApiV1MattersPartiesRelatedId = async (id, matterPartyRelationP
         body: JSON.stringify(matterPartyRelationPatchDto)
     });
 };
+/**
+ * @summary Deletes the Related Party with the given ID from its Matter.
+ */
 export const getDeleteApiV1MattersPartiesRelatedIdUrl = (id) => {
     return `/api/v1/Matters/parties/related/${id}`;
 };
@@ -1680,6 +2145,9 @@ export const deleteApiV1MattersPartiesRelatedId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Gets the Related Parties associated with a specific Primary Party.
+ */
 export const getGetApiV1MattersPartiesPrimaryPartyIdRelatedUrl = (primaryPartyId) => {
     return `/api/v1/Matters/parties/${primaryPartyId}/related`;
 };
@@ -1689,6 +2157,9 @@ export const getApiV1MattersPartiesPrimaryPartyIdRelated = async (primaryPartyId
         method: 'GET'
     });
 };
+/**
+ * @summary Gets the metadata for Matter Parties (Roles, for example).
+ */
 export const getGetApiV1MattersPartiesMetadataUrl = () => {
     return `/api/v1/Matters/parties/metadata`;
 };
@@ -1718,6 +2189,9 @@ export const patchApiV1MattersMatterIdFinance = async (matterId, matterFinancePa
         body: JSON.stringify(matterFinancePatchDto)
     });
 };
+/**
+ * @summary Gets the consolidated Finance field metadata (labels, visibility, options) for a Module.
+ */
 export const getGetApiV1MattersFinanceMetadataUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1754,6 +2228,9 @@ export const putApiV1MattersMatterIdEvaluation = async (matterId, putApiV1Matter
         body: JSON.stringify(putApiV1MattersMatterIdEvaluationBody)
     });
 };
+/**
+ * @summary Deletes a Matter and its related information.
+ */
 export const getDeleteApiV1MattersMatterIdUrl = (matterId, params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1770,6 +2247,11 @@ export const deleteApiV1MattersMatterId = async (matterId, params, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Gets all open matters assigned to the authenticated user.
+Corresponds to the Golden Gate my_open_matters view.
+Reference: https://github.com/CycomDataSystems/golden-gate/blob/main/apis/views/views.py::my_open_matters
+ */
 export const getGetApiV1MattersMyOpenUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1786,6 +2268,9 @@ export const getApiV1MattersMyOpen = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Gets the next available file number for a specified module.
+ */
 export const getGetApiV1MattersNextFileNumberUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1802,6 +2287,9 @@ export const getApiV1MattersNextFileNumber = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Creates a new Litigation matter
+ */
 export const getPostApiV1MattersUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1847,6 +2335,10 @@ export const getApiV2MattersFieldsMetadata = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Module-agnostic GET. Returns a unified MatterDto that covers all modules.
+The module is derived from BASE.Module on the existing record.
+ */
 export const getGetApiV3MattersMatterIdUrl = (matterId) => {
     return `/api/v3/matters/${matterId}`;
 };
@@ -1856,6 +2348,10 @@ export const getApiV3MattersMatterId = async (matterId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Module-agnostic PATCH. Applies a JSON Patch document to update any matter.
+The module is derived from BASE.Module on the existing record.
+ */
 export const getPatchApiV3MattersMatterIdUrl = (matterId) => {
     return `/api/v3/matters/${matterId}`;
 };
@@ -1867,6 +2363,10 @@ export const patchApiV3MattersMatterId = async (matterId, operation, options) =>
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Module-agnostic POST. Creates a new matter for any supported module
+(LI, CL, 3C, WC, LR, FS, AS).
+ */
 export const getPostApiV3MattersUrl = () => {
     return `/api/v3/matters`;
 };
@@ -1878,7 +2378,9 @@ export const postApiV3Matters = async (createMatterDto, options) => {
         body: JSON.stringify(createMatterDto)
     });
 };
-;
+/**
+ * @summary Retrieves a person by their ID.
+ */
 export const getGetApiV1PeopleIdUrl = (id) => {
     return `/api/v1/People/${id}`;
 };
@@ -1888,7 +2390,9 @@ export const getApiV1PeopleId = async (id, options) => {
         method: 'GET'
     });
 };
-;
+/**
+ * @summary Deletes a person by their ID.
+ */
 export const getDeleteApiV1PeopleIdUrl = (id) => {
     return `/api/v1/People/${id}`;
 };
@@ -1898,7 +2402,9 @@ export const deleteApiV1PeopleId = async (id, options) => {
         method: 'DELETE'
     });
 };
-;
+/**
+ * @summary Applies a JSON Patch to a person.
+ */
 export const getPatchApiV1PeopleIdUrl = (id) => {
     return `/api/v1/People/${id}`;
 };
@@ -1910,7 +2416,9 @@ export const patchApiV1PeopleId = async (id, operation, options) => {
         body: JSON.stringify(operation)
     });
 };
-;
+/**
+ * @summary Adds a new person.
+ */
 export const getPostApiV1PeopleUrl = () => {
     return `/api/v1/People`;
 };
@@ -1922,7 +2430,9 @@ export const postApiV1People = async (personDto, options) => {
         body: JSON.stringify(personDto)
     });
 };
-;
+/**
+ * @summary Searches for people based on the provided search criteria and returns a paginated result.
+ */
 export const getPostApiV1PeopleSearchUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1941,7 +2451,6 @@ export const postApiV1PeopleSearch = async (personSearchDto, params, options) =>
         body: JSON.stringify(personSearchDto)
     });
 };
-;
 export const getGetApiV1PermissionsStaffIdUrl = (staffId) => {
     return `/api/v1/Permissions/${staffId}`;
 };
@@ -1951,6 +2460,10 @@ export const getApiV1PermissionsStaffId = async (staffId, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Exports risk data as of a specified date as an Excel (.xlsx) spreadsheet.
+Each row represents one risk record; columns map to the properties of each record.
+ */
 export const getGetApiV1ReportsExportRiskDataReportUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1967,6 +2480,10 @@ export const getApiV1ReportsExportRiskDataReport = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Exports litigation manager report data as an Excel (.xlsx) spreadsheet.
+Each row represents one matter record; columns map to the properties of each record.
+ */
 export const getGetApiV1ReportsManagerReportUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -1983,7 +2500,18 @@ export const getApiV1ReportsManagerReport = async (params, options) => {
         method: 'GET'
     });
 };
-;
+/**
+ * @summary List Auth0 roles available in the tenant.
+ */
+export const getGetApiV1RolesUrl = () => {
+    return `/api/v1/roles`;
+};
+export const getApiV1Roles = async (options) => {
+    return customFetch(getGetApiV1RolesUrl(), {
+        ...options,
+        method: 'GET'
+    });
+};
 export const getPostApiV1SearchMattersUrl = () => {
     return `/api/v1/Search/matters`;
 };
@@ -1995,7 +2523,6 @@ export const postApiV1SearchMatters = async (matterSearchRequestDto, options) =>
         body: JSON.stringify(matterSearchRequestDto)
     });
 };
-;
 export const getPostApiV1SearchMattersPageNumberUrl = (pageNumber) => {
     return `/api/v1/Search/matters/${pageNumber}`;
 };
@@ -2032,6 +2559,9 @@ export const getApiV1SystemManagementConfidentialFooter = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get app settings filtered by section and/or item.
+ */
 export const getGetApiV1SystemManagementAppSettingsUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -2048,6 +2578,9 @@ export const getApiV1SystemManagementAppSettings = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new app setting.
+ */
 export const getPostApiV1SystemManagementAppSettingsUrl = () => {
     return `/api/v1/system-management/app-settings`;
 };
@@ -2059,6 +2592,9 @@ export const postApiV1SystemManagementAppSettings = async (createCtyLawDto, opti
         body: JSON.stringify(createCtyLawDto)
     });
 };
+/**
+ * @summary Update an app setting using JSON Patch (RFC 6902).
+ */
 export const getPatchApiV1SystemManagementAppSettingsIdUrl = (id) => {
     return `/api/v1/system-management/app-settings/${id}`;
 };
@@ -2070,6 +2606,9 @@ export const patchApiV1SystemManagementAppSettingsId = async (id, operation, opt
         body: JSON.stringify(operation)
     });
 };
+/**
+ * @summary Delete an app setting.
+ */
 export const getDeleteApiV1SystemManagementAppSettingsIdUrl = (id) => {
     return `/api/v1/system-management/app-settings/${id}`;
 };
@@ -2079,6 +2618,9 @@ export const deleteApiV1SystemManagementAppSettingsId = async (id, options) => {
         method: 'DELETE'
     });
 };
+/**
+ * @summary Triggers the TIPSS sync operation, importing data into ATSystem* tables.
+ */
 export const getPostApiV1TipssSyncUrl = () => {
     return `/api/v1/tipss/sync`;
 };
@@ -2090,6 +2632,9 @@ export const postApiV1TipssSync = async (tipssSyncRequestDto, options) => {
         body: JSON.stringify(tipssSyncRequestDto)
     });
 };
+/**
+ * @summary Syncs green form printed records by executing the UpdateGreenFormPrintedRecords stored procedure.
+ */
 export const getPostApiV1TipssGreenFormSyncUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -2106,6 +2651,9 @@ export const postApiV1TipssGreenFormSync = async (params, options) => {
         method: 'POST'
     });
 };
+/**
+ * @summary Searches citations by citation number and/or defendant name.
+ */
 export const getGetApiV1TipssCitationsSearchUrl = (params) => {
     const normalizedParams = new URLSearchParams();
     Object.entries(params || {}).forEach(([key, value]) => {
@@ -2122,6 +2670,175 @@ export const getApiV1TipssCitationsSearch = async (params, options) => {
         method: 'GET'
     });
 };
+/**
+ * Cursor-paginated. Filters: `isBlocked`, `staffId`, and a
+free-text `search` over StaffId / Auth0 sub / Staff name. Email
+and display-name search are delegated to Auth0 and not currently
+part of this filter.
+ * @summary List users in the caller's organization.
+ */
+export const getGetApiV1UsersUrl = (params) => {
+    const normalizedParams = new URLSearchParams();
+    Object.entries(params || {}).forEach(([key, value]) => {
+        if (value !== undefined) {
+            normalizedParams.append(key, value === null ? 'null' : value.toString());
+        }
+    });
+    const stringifiedParams = normalizedParams.toString();
+    return stringifiedParams.length > 0 ? `/api/v1/users?${stringifiedParams}` : `/api/v1/users`;
+};
+export const getApiV1Users = async (params, options) => {
+    return customFetch(getGetApiV1UsersUrl(params), {
+        ...options,
+        method: 'GET'
+    });
+};
+/**
+ * Discriminated by `mode`: `linkExisting` requires a
+`staffId` that already exists in the caller's organization;
+`createNew` requires `staffPayload` and Mackinac generates
+the next sequential 7-digit StaffId. Enforces the Organization's
+`seatCount` metadata. Sends an Auth0 Organization invitation
+when `sendInvitation = true`.
+ * @summary Create a user.
+ */
+export const getPostApiV1UsersUrl = () => {
+    return `/api/v1/users`;
+};
+export const postApiV1Users = async (createUserDto, options) => {
+    return customFetch(getPostApiV1UsersUrl(), {
+        ...options,
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json-patch+json', ...options?.headers },
+        body: JSON.stringify(createUserDto)
+    });
+};
+/**
+ * Detail view includes `roleIds` (fetched from Auth0). On
+transient Auth0 failures the response omits roleIds rather than
+failing the whole request — caller can retry.
+ * @summary Get a single user.
+ */
+export const getGetApiV1UsersIdUrl = (id) => {
+    return `/api/v1/users/${id}`;
+};
+export const getApiV1UsersId = async (id, options) => {
+    return customFetch(getGetApiV1UsersIdUrl(id), {
+        ...options,
+        method: 'GET'
+    });
+};
+/**
+ * Any null body field is left unchanged. `email` and
+`displayName` propagate to Auth0; `staffName` and
+`title` propagate to the linked Staff row. Email change
+re-sets Auth0's email-verified flag to false.
+ * @summary Admin: update a user's profile fields.
+ */
+export const getPatchApiV1UsersIdUrl = (id) => {
+    return `/api/v1/users/${id}`;
+};
+export const patchApiV1UsersId = async (id, updateUserDto, options) => {
+    return customFetch(getPatchApiV1UsersIdUrl(id), {
+        ...options,
+        method: 'PATCH',
+        headers: { 'Content-Type': 'application/json-patch+json', ...options?.headers },
+        body: JSON.stringify(updateUserDto)
+    });
+};
+/**
+ * Visible to all authenticated users (no admin permission required).
+Writes to Auth0; the change takes effect on the user's next session.
+ * @summary Self-service: update your own display name.
+ */
+export const getPutApiV1UsersMeUrl = () => {
+    return `/api/v1/users/me`;
+};
+export const putApiV1UsersMe = async (updateSelfProfileDto, options) => {
+    return customFetch(getPutApiV1UsersMeUrl(), {
+        ...options,
+        method: 'PUT',
+        headers: { 'Content-Type': 'application/json-patch+json', ...options?.headers },
+        body: JSON.stringify(updateSelfProfileDto)
+    });
+};
+/**
+ * @summary Block a user (Auth0 blocked + Staff inactive).
+ */
+export const getPostApiV1UsersIdBlockUrl = (id) => {
+    return `/api/v1/users/${id}/block`;
+};
+export const postApiV1UsersIdBlock = async (id, options) => {
+    return customFetch(getPostApiV1UsersIdBlockUrl(id), {
+        ...options,
+        method: 'POST'
+    });
+};
+/**
+ * @summary Unblock a user (reverse of block).
+ */
+export const getPostApiV1UsersIdUnblockUrl = (id) => {
+    return `/api/v1/users/${id}/unblock`;
+};
+export const postApiV1UsersIdUnblock = async (id, options) => {
+    return customFetch(getPostApiV1UsersIdUnblockUrl(id), {
+        ...options,
+        method: 'POST'
+    });
+};
+/**
+ * @summary Trigger a password-reset email to the user.
+ */
+export const getPostApiV1UsersIdPasswordResetUrl = (id) => {
+    return `/api/v1/users/${id}/password-reset`;
+};
+export const postApiV1UsersIdPasswordReset = async (id, options) => {
+    return customFetch(getPostApiV1UsersIdPasswordResetUrl(id), {
+        ...options,
+        method: 'POST'
+    });
+};
+/**
+ * @summary Send (or re-send) an Auth0 Organization invitation.
+ */
+export const getPostApiV1UsersIdInvitationUrl = (id) => {
+    return `/api/v1/users/${id}/invitation`;
+};
+export const postApiV1UsersIdInvitation = async (id, options) => {
+    return customFetch(getPostApiV1UsersIdInvitationUrl(id), {
+        ...options,
+        method: 'POST'
+    });
+};
+/**
+ * @summary Assign one or more Auth0 roles to a user within the org.
+ */
+export const getPostApiV1UsersIdRolesUrl = (id) => {
+    return `/api/v1/users/${id}/roles`;
+};
+export const postApiV1UsersIdRoles = async (id, assignRolesDto, options) => {
+    return customFetch(getPostApiV1UsersIdRolesUrl(id), {
+        ...options,
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json-patch+json', ...options?.headers },
+        body: JSON.stringify(assignRolesDto)
+    });
+};
+/**
+ * @summary Unassign a single Auth0 role from a user within the org.
+ */
+export const getDeleteApiV1UsersIdRolesRoleIdUrl = (id, roleId) => {
+    return `/api/v1/users/${id}/roles/${roleId}`;
+};
+export const deleteApiV1UsersIdRolesRoleId = async (id, roleId, options) => {
+    return customFetch(getDeleteApiV1UsersIdRolesRoleIdUrl(id, roleId), {
+        ...options,
+        method: 'DELETE'
+    });
+};
+/**
+ * @summary Get configuration data for WRP integration
+ */
 export const getGetApiV1WrpConfigUrl = () => {
     return `/api/v1/Wrp/config`;
 };
@@ -2131,6 +2848,9 @@ export const getApiV1WrpConfig = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get field metadata for the Work Request Portal form
+ */
 export const getGetApiV1WrpMetadataUrl = () => {
     return `/api/v1/Wrp/metadata`;
 };
@@ -2140,6 +2860,9 @@ export const getApiV1WrpMetadata = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get a database-driven form definition by form key
+ */
 export const getGetApiV1WrpFormsFormKeyUrl = (formKey) => {
     return `/api/v1/Wrp/forms/${formKey}`;
 };
@@ -2149,6 +2872,9 @@ export const getApiV1WrpFormsFormKey = async (formKey, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get active code items for a given code type
+ */
 export const getGetApiV1WrpOptionsCodesCodeTypeUrl = (codeType) => {
     return `/api/v1/Wrp/options/codes/${codeType}`;
 };
@@ -2158,6 +2884,9 @@ export const getApiV1WrpOptionsCodesCodeType = async (codeType, options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get active departments
+ */
 export const getGetApiV1WrpOptionsDepartmentsUrl = () => {
     return `/api/v1/Wrp/options/departments`;
 };
@@ -2167,6 +2896,9 @@ export const getApiV1WrpOptionsDepartments = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Get active accounts
+ */
 export const getGetApiV1WrpOptionsAccountsUrl = () => {
     return `/api/v1/Wrp/options/accounts`;
 };
@@ -2176,6 +2908,9 @@ export const getApiV1WrpOptionsAccounts = async (options) => {
         method: 'GET'
     });
 };
+/**
+ * @summary Create a new Assignment Matter for the Work Request Portal
+ */
 export const getPostApiV1WrpAssignmentMatterUrl = () => {
     return `/api/v1/Wrp/assignment-matter`;
 };