singularName
singularName: string
pluralName
pluralName: string
fieldsSchema
fieldsSchema: any
Optional
description
description?: string
Optional
categories
categories?: (
| "Accounting"
| "Ads"
| "Analytics"
| "ATS"
| "Communication"
| "CRM"
| "Customer Success"
| "Document Management"
| "E-Commerce"
| "E-Signature"
| "ERP"
| "File Storage"
| "HRIS"
| "Legal"
| "Marketing Automation"
| "Payments"
| "Project Management"
| "Sales"
| "Ticketing"
)[]
Optional
normalizeFields
normalizeFields?: (fields: Record<string, any>) => Record<string, any>
Optional
populateFields
populateFields?: (fields: Record<string, any>) => Record<string, any>
Optional
list
list?: {
apiRequests?: { path: unknown; method: unknown }[];
filterFields?: string[];
}
Optional
find
find?: {
apiRequests?: { path: unknown; method: unknown }[];
queryFields?: string[];
}
Optional
match
match?: {
apiRequests?: { path: unknown; method: unknown }[];
fields?: string[];
}
Optional
create
create?: {
apiRequests?: { path: unknown; method: unknown }[];
fields?: string[];
requiredFields?: string[];
excludedFields?: string[];
}
Optional
update
update?: {
apiRequests?: { path: unknown; method: unknown }[];
fields?: string[];
excludedFields?: string[];
}
Optional
delete
delete?: { apiRequests?: { path: unknown; method: unknown }[] }
Optional
udmFallbacks
Optional
fieldFallbacks