@cycomdatasystems/mackinac-sdk 5.2.3 → 6.0.0

package/dist/generated/mackinac.client.d.ts

@@ -14,7 +14,7 @@
 - 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-Local
  */
-import type { AddsDeptDto, AllegationDesiredOutcomeDto, AllegationDesiredOutcomeDtoPaginatedResultDto, AllegationDto, AllegationDtoPaginatedResultDto, AllegationIssueDetailsDto, AllegationIssueDetailsDtoPaginatedResultDto, AllegationIssueDto, AllegationIssueDtoPaginatedResultDto, AllegationStageDispositionDto, AllegationStageDispositionDtoPaginatedResultDto, AllegationStageDto, AllegationStageDtoPaginatedResultDto, AllegationSubCodeDto, AllegationSubCodeDtoPaginatedResultDto, AssignRolesDto, BulkMatterAllegationStageRowDtoPaginatedResultDto, CodeDto, ConfidentialFooterDto, ContractCounselDto, ContractCounselDtoPaginatedResultDto, CouncilDistrictsViewDto, CreateAllegationDesiredOutcomeDto, CreateAllegationDto, CreateAllegationIssueDetailsDto, CreateAllegationIssueDto, CreateAllegationStageDispositionDto, CreateAllegationStageDto, CreateAllegationSubCodeDto, CreateContractCounselDto, CreateCtyLawDto, CreateExpenseReserveDto, CreateExpertWitnessDto, CreateFormDefinitionDto, CreateFormSubmissionDto, CreateGeneralExpenseDto, CreateIndemnityReserveDto, CreateLitigationMatterRequestDto, CreateMatterAllegationDto, CreateMatterAllegationStageDto, CreateMatterDto, CreateMatterFormLayoutDto, CreatePaymentDto, CreateSettlementDto, CreateStageDispositionMappingDto, CreateUpdateFieldDefinitionDto, CreateUpdateFormElementDto, CreateUpdateFormFieldDto, CreateUpdateFormFieldRuleDto, CreateUpdateFormSubmissionActionDto, CreateUserDto, CreateWrpAssignmentMatterDto, CtyLawDto, DeleteApiV1MattersMatterIdParams, DocumentSearchCriteriaDto, DocumentSearchResponseDto, EmailSubjectDto, ExpenseReserveDto, ExpenseReserveDtoPaginatedResultDto, ExpertWitnessDto, ExpertWitnessDtoPaginatedResultDto, FieldDefinitionDto, FieldDefinitionDtoCursorPagedResultDto, FileLimitsDto, FileUploadResultDto, FormDefinitionDto, FormDefinitionDtoCursorPagedResultDto, FormDefinitionFullDto, FormElementDto, FormElementDtoListResultDto, FormFieldDto, FormFieldDtoListResultDto, FormFieldRuleDto, FormFieldRuleDtoListResultDto, FormSubmissionActionDto, FormSubmissionActionDtoListResultDto, FormSubmissionDto, FormSubmissionDtoCursorPagedResultDto, GeneralExpenseDto, GeneralExpenseDtoPaginatedResultDto, GetApiV1AllegationsDesiredOutcomesParams, GetApiV1AllegationsIssueDetailsParams, GetApiV1AllegationsIssuesParams, GetApiV1AllegationsParams, GetApiV1AllegationsStageDispositionsParams, GetApiV1AllegationsStagesDispositionMappingsParams, GetApiV1AllegationsStagesParams, GetApiV1AllegationsSubcodesParams, GetApiV1CodesDispositionsModuleCodeParams, GetApiV1CodesParams, GetApiV1FieldDefinitionsParams, GetApiV1FormDefinitionsFormIdRulesParams, GetApiV1FormDefinitionsFormIdSubmissionsParams, GetApiV1FormDefinitionsParams, GetApiV1MatterFieldRegistryParams, GetApiV1MattersAllegationsAllegationIdStagesParams, GetApiV1MattersFieldsMetadataAccountParams, GetApiV1MattersFieldsMetadataCreateParams, GetApiV1MattersFieldsMetadataDepartmentParams, GetApiV1MattersFieldsMetadataParams, GetApiV1MattersFileNumberExistsParams, GetApiV1MattersFinanceMetadataParams, GetApiV1MattersMatterIdAllegationsParams, GetApiV1MattersMatterIdAllegationsStagesParams, GetApiV1MattersMatterIdFinanceCollectionsCollectedParams, GetApiV1MattersMatterIdFinanceExpendituresContractCounselParams, GetApiV1MattersMatterIdFinanceExpendituresExpertWitnessParams, GetApiV1MattersMatterIdFinanceExpendituresGeneralExpensesParams, GetApiV1MattersMatterIdFinanceExpendituresSettlementsParams, GetApiV1MattersMatterIdFinanceReservesExpensesParams, GetApiV1MattersMyOpenParams, GetApiV1MattersNextFileNumberParams, GetApiV1PeopleStaffModuleCodeParams, GetApiV1ReportsExportRiskDataReportParams, GetApiV1ReportsManagerReportParams, GetApiV1StaffParams, GetApiV1SystemManagementAppSettingsParams, GetApiV1TimeentriesParams, GetApiV1TipssCitationsSearchParams, GetApiV1UsersParams, GetApiV2MattersFieldsMetadataParams, IndemnityReserveDto, LabelAndPeopleDto, LabelAndStaffDto, LabelAndVisibilityDto, LabelDto, LitigationMatterAbstractDto, LitigationMatterDto, MarkAveryLabelsPrintedRequest, MatterAllegationDto, MatterAllegationDtoPaginatedResultDto, MatterAllegationStageDto, MatterAllegationStageDtoPaginatedResultDto, MatterArchiveRemarksDto, MatterDispositionPatchDto, MatterDispositionTextDto, MatterDto, MatterFieldMetadataDto, MatterFieldMetadataV2Dto, MatterFieldRegistryDto, MatterFieldRegistryDtoListResultDto, MatterFinanceFieldValuesDto, MatterFinanceMetadataDto, MatterFinancePatchDto, MatterPartyPatchDto, MatterPartyPostDto, MatterPartyRelationPatchDto, MatterPaymentMetadataDto, MatterPersonDto, MatterPersonRelationDto, MatterSearchHitsRequestDto, MatterSearchRequestDto, MatterStatusPatchDto, MatterStatusTextDto, NextFileNumberResponseDto, NoteDto, OpenMatterDto, Operation, PaymentDto, PaymentDtoPaginatedResultDto, PersonDto, PersonDtoIEnumerableInt32ValueTuple, PersonSearchDto, PostApiV1MattersParams, PostApiV1PeopleSearchParams, PostApiV1TipssGreenFormSyncParams, PotdDto, RoleDto, SearchCitationHitDtoPaginatedResultDto, SettlementDto, SettlementDtoPaginatedResultDto, StaffDto, StageDispositionMappingDto, StageDispositionMappingDtoPaginatedResultDto, SystemAccountsDto, SystemDepartmentsDto, TimeEntryViewDto, TipssSyncRequestDto, TipssSyncResponseDto, TracksViewDto, UpdateFormDefinitionDto, UpdateSelfProfileDto, UpdateUserDto, UserDto, UserDtoCursorPagedResultDto, ViewCodeDto, ViewCodeWithTypeDto, WrpAssignmentMatterResponseDto, WrpConfigDto, WrpFormDefinitionDto, WrpMetadataDto, WrpSelectOptionDto } from './models';
+import type { AddsDeptDto, AllegationDesiredOutcomeDto, AllegationDesiredOutcomeDtoPaginatedResultDto, AllegationDto, AllegationDtoPaginatedResultDto, AllegationIssueDetailsDto, AllegationIssueDetailsDtoPaginatedResultDto, AllegationIssueDto, AllegationIssueDtoPaginatedResultDto, AllegationStageDispositionDto, AllegationStageDispositionDtoPaginatedResultDto, AllegationStageDto, AllegationStageDtoPaginatedResultDto, AllegationSubCodeDto, AllegationSubCodeDtoPaginatedResultDto, AssignRolesDto, BulkMatterAllegationStageRowDtoPaginatedResultDto, CodeDto, ConfidentialFooterDto, ContractCounselDto, ContractCounselDtoPaginatedResultDto, CouncilDistrictsViewDto, CreateAllegationDesiredOutcomeDto, CreateAllegationDto, CreateAllegationIssueDetailsDto, CreateAllegationIssueDto, CreateAllegationStageDispositionDto, CreateAllegationStageDto, CreateAllegationSubCodeDto, CreateContractCounselDto, CreateCtyLawDto, CreateExpenseReserveDto, CreateExpertWitnessDto, CreateFormDefinitionDto, CreateFormSubmissionDto, CreateGeneralExpenseDto, CreateIndemnityReserveDto, CreateLitigationMatterRequestDto, CreateMatterAllegationDto, CreateMatterAllegationStageDto, CreateMatterDto, CreateMatterFormLayoutDto, CreatePaymentDto, CreateSettlementDto, CreateStageDispositionMappingDto, CreateUpdateFieldDefinitionDto, CreateUpdateFormElementDto, CreateUpdateFormFieldDto, CreateUpdateFormFieldRuleDto, CreateUpdateFormSubmissionActionDto, CreateUserDto, CreateWrpAssignmentMatterDto, CtyLawDto, DeleteApiV1MattersMatterIdParams, DocumentSearchCriteriaDto, DocumentSearchResponseDto, EmailSubjectDto, ExpenseReserveDto, ExpenseReserveDtoPaginatedResultDto, ExpertWitnessDto, ExpertWitnessDtoPaginatedResultDto, FieldDefinitionDto, FieldDefinitionDtoCursorPagedResultDto, FileLimitsDto, FileUploadResultDto, FormDefinitionDto, FormDefinitionDtoCursorPagedResultDto, FormDefinitionFullDto, FormElementDto, FormElementDtoListResultDto, FormFieldDto, FormFieldDtoListResultDto, FormFieldRuleDto, FormFieldRuleDtoListResultDto, FormSubmissionActionDto, FormSubmissionActionDtoListResultDto, FormSubmissionDto, FormSubmissionDtoCursorPagedResultDto, GeneralExpenseDto, GeneralExpenseDtoPaginatedResultDto, GetApiV1AllegationsDesiredOutcomesParams, GetApiV1AllegationsIssueDetailsParams, GetApiV1AllegationsIssuesParams, GetApiV1AllegationsParams, GetApiV1AllegationsStageDispositionsParams, GetApiV1AllegationsStagesDispositionMappingsParams, GetApiV1AllegationsStagesParams, GetApiV1AllegationsSubcodesParams, GetApiV1CodesDispositionsModuleCodeParams, GetApiV1CodesParams, GetApiV1FieldDefinitionsParams, GetApiV1FormDefinitionsFormIdRulesParams, GetApiV1FormDefinitionsFormIdSubmissionsParams, GetApiV1FormDefinitionsParams, GetApiV1MatterFieldRegistryParams, GetApiV1MattersAllegationsAllegationIdStagesParams, GetApiV1MattersFieldsMetadataAccountParams, GetApiV1MattersFieldsMetadataCreateParams, GetApiV1MattersFieldsMetadataDepartmentParams, GetApiV1MattersFieldsMetadataParams, GetApiV1MattersFileNumberExistsParams, GetApiV1MattersFinanceMetadataParams, GetApiV1MattersMatterIdAllegationsParams, GetApiV1MattersMatterIdAllegationsStagesParams, GetApiV1MattersMatterIdFinanceCollectionsCollectedParams, GetApiV1MattersMatterIdFinanceExpendituresContractCounselParams, GetApiV1MattersMatterIdFinanceExpendituresExpertWitnessParams, GetApiV1MattersMatterIdFinanceExpendituresGeneralExpensesParams, GetApiV1MattersMatterIdFinanceExpendituresSettlementsParams, GetApiV1MattersMatterIdFinanceReservesExpensesParams, GetApiV1MattersMyOpenParams, GetApiV1MattersNextFileNumberParams, GetApiV1MattersPartiesMetadataParams, GetApiV1PeopleStaffModuleCodeParams, GetApiV1ReportsExportRiskDataReportParams, GetApiV1ReportsManagerReportParams, GetApiV1StaffParams, GetApiV1SystemManagementAppSettingsParams, GetApiV1TimeentriesParams, GetApiV1TipssCitationsSearchParams, GetApiV1UsersParams, GetApiV2MattersFieldsMetadataParams, IndemnityReserveDto, LabelAndPeopleDto, LabelAndStaffDto, LabelAndVisibilityDto, LabelDto, LitigationMatterAbstractDto, LitigationMatterDto, MarkAveryLabelsPrintedRequest, MatterAllegationDto, MatterAllegationDtoPaginatedResultDto, MatterAllegationStageDto, MatterAllegationStageDtoPaginatedResultDto, MatterArchiveRemarksDto, MatterDispositionPatchDto, MatterDispositionTextDto, MatterDto, MatterFieldMetadataDto, MatterFieldMetadataV2Dto, MatterFieldRegistryDto, MatterFieldRegistryDtoListResultDto, MatterFinanceFieldValuesDto, MatterFinanceMetadataDto, MatterFinancePatchDto, MatterPartyPatchDto, MatterPartyPostDto, MatterPartyRelationPatchDto, MatterPaymentMetadataDto, MatterPersonDto, MatterPersonRelationDto, MatterSearchHitsRequestDto, MatterSearchRequestDto, MatterStatusPatchDto, MatterStatusTextDto, NextFileNumberResponseDto, NoteDto, OpenMatterDto, Operation, PaymentDto, PaymentDtoPaginatedResultDto, PersonDto, PersonDtoIEnumerableInt32ValueTuple, PersonSearchDto, PostApiV1MattersParams, PostApiV1PeopleSearchParams, PostApiV1TipssGreenFormSyncParams, PotdDto, RoleDto, SearchCitationHitDtoPaginatedResultDto, SettlementDto, SettlementDtoPaginatedResultDto, StaffDto, StageDispositionMappingDto, StageDispositionMappingDtoPaginatedResultDto, SystemAccountsDto, SystemDepartmentsDto, TimeEntryViewDto, TipssSyncRequestDto, TipssSyncResponseDto, TracksViewDto, UpdateFormDefinitionDto, UpdateSelfProfileDto, UpdateUserDto, UserDto, UserDtoCursorPagedResultDto, ViewCodeDto, ViewCodeWithTypeDto, WrpAssignmentMatterResponseDto, WrpConfigDto, WrpFormDefinitionDto, WrpMetadataDto, WrpSelectOptionDto } from './models';
 /**
  * @summary Get a paginated list of allegation definitions.
  */
@@ -946,10 +946,11 @@ export declare const deleteApiV1MattersPartiesRelatedId: (id: number, options?:
 export declare const getGetApiV1MattersPartiesPrimaryPartyIdRelatedUrl: (primaryPartyId: number) => string;
 export declare const getApiV1MattersPartiesPrimaryPartyIdRelated: (primaryPartyId: number, options?: RequestInit) => Promise<void>;
 /**
- * @summary Gets the metadata for Matter Parties (Roles, for example).
+ * @summary Gets the metadata for Matter Parties (roles, witness roles, related-party
+relationships, profile types, and prefixes) for the given module.
  */
-export declare const getGetApiV1MattersPartiesMetadataUrl: () => string;
-export declare const getApiV1MattersPartiesMetadata: (options?: RequestInit) => Promise<void>;
+export declare const getGetApiV1MattersPartiesMetadataUrl: (params?: GetApiV1MattersPartiesMetadataParams) => string;
+export declare const getApiV1MattersPartiesMetadata: (params?: GetApiV1MattersPartiesMetadataParams, options?: RequestInit) => Promise<void>;
 export declare const getGetApiV1MattersMatterIdFinanceUrl: (matterId: number) => string;
 export declare const getApiV1MattersMatterIdFinance: (matterId: number, options?: RequestInit) => Promise<MatterFinanceFieldValuesDto>;
 export declare const getPatchApiV1MattersMatterIdFinanceUrl: (matterId: number) => string;

package/dist/generated/mackinac.client.js

@@ -2502,13 +2502,21 @@ export const getApiV1MattersPartiesPrimaryPartyIdRelated = async (primaryPartyId
     });
 };
 /**
- * @summary Gets the metadata for Matter Parties (Roles, for example).
+ * @summary Gets the metadata for Matter Parties (roles, witness roles, related-party
+relationships, profile types, and prefixes) for the given module.
  */
-export const getGetApiV1MattersPartiesMetadataUrl = () => {
-    return `/api/v1/Matters/parties/metadata`;
+export const getGetApiV1MattersPartiesMetadataUrl = (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/Matters/parties/metadata?${stringifiedParams}` : `/api/v1/Matters/parties/metadata`;
 };
-export const getApiV1MattersPartiesMetadata = async (options) => {
-    return customFetch(getGetApiV1MattersPartiesMetadataUrl(), {
+export const getApiV1MattersPartiesMetadata = async (params, options) => {
+    return customFetch(getGetApiV1MattersPartiesMetadataUrl(params), {
         ...options,
         method: 'GET'
     });

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

@@ -0,0 +1,24 @@
+/**
+ * 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-Local
+ */
+export type GetApiV1MattersPartiesMetadataParams = {
+    /**
+     * The two-character module code identifying which module's party metadata to
+    retrieve. Supported codes: `3C`, `CL`, `FS`, `LI`,
+    `LR`, `WC`.
+     */
+    moduleCode?: string;
+};

package/dist/generated/models/getApiV1MattersPartiesMetadataParams.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-Local
+ */
+export {};

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

@@ -181,6 +181,7 @@ export * from './getApiV1MattersMatterIdFinanceExpendituresSettlementsParams';
 export * from './getApiV1MattersMatterIdFinanceReservesExpensesParams';
 export * from './getApiV1MattersMyOpenParams';
 export * from './getApiV1MattersNextFileNumberParams';
+export * from './getApiV1MattersPartiesMetadataParams';
 export * from './getApiV1PeopleStaffModuleCodeParams';
 export * from './getApiV1ReportsExportRiskDataReportParams';
 export * from './getApiV1ReportsManagerReportParams';

package/dist/generated/models/index.js

@@ -181,6 +181,7 @@ export * from './getApiV1MattersMatterIdFinanceExpendituresSettlementsParams';
 export * from './getApiV1MattersMatterIdFinanceReservesExpensesParams';
 export * from './getApiV1MattersMyOpenParams';
 export * from './getApiV1MattersNextFileNumberParams';
+export * from './getApiV1MattersPartiesMetadataParams';
 export * from './getApiV1PeopleStaffModuleCodeParams';
 export * from './getApiV1ReportsExportRiskDataReportParams';
 export * from './getApiV1ReportsManagerReportParams';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cycomdatasystems/mackinac-sdk",
-  "version": "5.2.3",
+  "version": "6.0.0",
   "description": "A shared TypeScript client for the Mackinac API.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",