import {z} from 'zod' export type CharacteristicTypeAssignmentReference = {id: string, min?: number | undefined, max?: number | undefined, readOnly?: boolean | undefined, type?: ('View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context') | undefined, resourceDiscriminator?: string | undefined, relationTypeDirection?: ('TO_SOURCE' | 'TO_TARGET' | 'BOTH' | 'NONE') | undefined, relationTypeRestriction?: string | undefined}; export type ArticulationRuleRequest = {id?: string | undefined, operation: 'ADD' | 'SET', score: number, statusId?: string | undefined, attributeTypeId?: string | undefined}; export type AddAssignmentRequest = {id?: string | undefined, assetTypeId: string, statusIds: Array, characteristicTypes?: Array | undefined, articulationRules?: Array | undefined, validationRuleIds?: Array | undefined, dataQualityRuleIds?: Array | undefined, domainTypeIds?: Array | undefined, defaultStatusId?: string | undefined, scopeId?: string | undefined}; export type CreateApiAssignmentsArgs = {body: AddAssignmentRequest}; export type CreateApiAssignmentsOptions = {baseUrl: string, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const resourceType = z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]); export const namedResourceReferenceImpl = z.object({id: z.string(), name: z.string().optional(), resourceType: resourceType}); export const namedDescribedResourceReference = z.object({id: z.string(), resourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), resourceDiscriminator: z.string().optional(), name: z.string().optional(), description: z.string().optional()}); export const assignedCharacteristicType = z.object({readOnly: z.boolean().optional(), system: z.boolean().optional(), assignedResourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), assignedCharacteristicTypeDiscriminator: z.string().optional(), minimumOccurrences: z.number().int().optional(), assignedResourceId: z.string().optional(), maximumOccurrences: z.number().int().optional(), id: z.string().optional()}); export const assignedCharacteristicTypeReferenceImpl = z.object({id: z.string().optional(), assignedResourceReference: namedResourceReferenceImpl.optional(), assignedResourcePublicId: z.string().optional(), minimumOccurrences: z.number().int().optional(), maximumOccurrences: z.number().int().optional(), system: z.boolean().optional(), readOnly: z.boolean().optional(), relationTypeDirection: z.enum(["TO_SOURCE", "TO_TARGET", "BOTH", "NONE"]).optional(), relationTypeRestriction: namedResourceReferenceImpl.optional(), matchingLegTypesIds: z.array(z.string()).optional()}); export const articulationRuleImpl = z.object({id: z.string(), createdBy: z.string().optional(), createdOn: z.number().int().optional(), lastModifiedBy: z.string().optional(), lastModifiedOn: z.number().int().optional(), system: z.boolean().optional(), resourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), score: z.number().optional(), operation: z.enum(["ADD", "SET"]).optional(), status: namedResourceReferenceImpl.optional(), attributeType: namedResourceReferenceImpl.optional()}); export const scopeImpl = z.object({id: z.string(), createdBy: z.string().optional(), createdOn: z.number().int().optional(), lastModifiedBy: z.string().optional(), lastModifiedOn: z.number().int().optional(), system: z.boolean().optional(), resourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), name: z.string().optional(), description: z.string().optional(), publicId: z.string().optional(), domains: z.array(namedResourceReferenceImpl).optional(), communities: z.array(namedResourceReferenceImpl).optional()}); export const resourceReference = z.object({id: z.string(), resourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), resourceDiscriminator: z.string().optional()}); export const traitAssignmentInheritance = z.object({scope: namedResourceReferenceImpl.optional(), characteristicTypes: z.array(assignedCharacteristicType).optional(), assignedCharacteristicTypeReferences: z.array(assignedCharacteristicTypeReferenceImpl).optional(), traitAssignment: resourceReference.optional(), trait: namedResourceReferenceImpl.optional(), assetType: namedResourceReferenceImpl.optional()}); export const assignmentInheritance = z.object({scope: namedResourceReferenceImpl.optional(), traitAssignmentInheritances: z.array(traitAssignmentInheritance).optional(), assignment: resourceReference.optional(), assetType: namedResourceReferenceImpl.optional()}); export const assignmentImpl = z.object({id: z.string(), createdBy: z.string().optional(), createdOn: z.number().int().optional(), lastModifiedBy: z.string().optional(), lastModifiedOn: z.number().int().optional(), system: z.boolean().optional(), resourceType: z.enum(["View", "Asset", "Community", "Domain", "AssetType", "DomainType", "Status", "User", "ClassificationMatch", "UserGroup", "Attribute", "StringAttribute", "ScriptAttribute", "BooleanAttribute", "DateAttribute", "NumericAttribute", "SingleValueListAttribute", "MultiValueListAttribute", "Comment", "Attachment", "Responsibility", "Workflow", "Job", "Relation", "RelationType", "ComplexRelation", "ComplexRelationType", "ArticulationRule", "Assignment", "Scope", "RelationTrace", "ValidationRule", "DataQualityRule", "DataQualityMetric", "Address", "InstantMessagingAccount", "Email", "PhoneNumber", "Website", "Activity", "FormProperty", "WorkflowTask", "ActivityChange", "WorkflowInstance", "Role", "AttributeType", "BooleanAttributeType", "DateAttributeType", "DateTimeAttributeType", "MultiValueListAttributeType", "NumericAttributeType", "ScriptAttributeType", "SingleValueListAttributeType", "StringAttributeType", "ViewSharingRule", "ViewAssignmentRule", "JdbcDriverFile", "JdbcDriver", "JdbcIngestionProperties", "CsvIngestionProperties", "ExcelIngestionProperties", "ConnectionStringParameter", "AssignedCharacteristicType", "Notification", "Tag", "ComplexRelationLegType", "ComplexRelationAttributeType", "ComplexRelationLeg", "BaseDataType", "AdvancedDataType", "DiagramPicture", "DiagramPictureSharingRule", "DiagramPictureAssignmentRule", "Rating", "Classification", "PhysicalDataConnector", "Context"]), assetType: namedResourceReferenceImpl.optional(), statuses: z.array(namedDescribedResourceReference).optional(), defaultStatusId: z.string().optional(), characteristicTypes: z.array(assignedCharacteristicType).optional(), assignedCharacteristicTypeReferences: z.array(assignedCharacteristicTypeReferenceImpl).optional(), articulationRules: z.array(articulationRuleImpl).optional(), validationRules: z.array(namedResourceReferenceImpl).optional(), dataQualityRules: z.array(namedDescribedResourceReference).optional(), domainTypes: z.array(namedDescribedResourceReference).optional(), scope: scopeImpl.optional(), assignmentInheritances: z.array(assignmentInheritance).optional(), traitAssignmentInheritances: z.array(traitAssignmentInheritance).optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Adds a new Assignment. * * POST /assignments * * Also accepts auth: jwtAuth, oauth2, oauth2 */ export const createApiAssignments = async (args: CreateApiAssignmentsArgs, options: CreateApiAssignmentsOptions) => { const {baseUrl, fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/assignments${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(assignmentImpl, await res.json()) };