@unito/integration-api
Version:
The Unito Integration API
564 lines (563 loc) • 20.6 kB
TypeScript
export declare const fieldTypeCompatibilityMatrix: {
readonly blob: {
readonly blob: {};
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: null;
readonly markdown: null;
readonly string: null;
readonly url: null;
};
readonly boolean: {
readonly blob: null;
readonly boolean: {};
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly date: {
readonly blob: null;
readonly boolean: null;
readonly date: {};
readonly dateRange: null;
readonly datetime: {};
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly markdown: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly string: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly url: null;
};
readonly dateRange: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: null;
readonly markdown: null;
readonly string: null;
readonly url: null;
};
readonly datetime: {
readonly blob: null;
readonly boolean: null;
readonly date: {};
readonly dateRange: null;
readonly datetime: {};
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly markdown: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly string: {
readonly locale: {
readonly type: "enum";
readonly defaults: [{
readonly value: "en-CA";
}];
readonly values: ["en-CA"];
readonly description: "The locale to use for formatting the date.";
};
readonly timezone: {
readonly type: "enum";
readonly defaults: [{
readonly value: "UTC";
}];
readonly values: ["UTC"];
readonly description: "The timezone to use for formatting the date.";
};
};
readonly url: null;
};
readonly datetimeRange: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: null;
readonly markdown: null;
readonly string: null;
readonly url: null;
};
readonly duration: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: {};
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly email: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: {};
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: {
readonly field: {
readonly type: "targetField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field against which to match the string value.";
readonly required: true;
};
};
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly integer: {
readonly blob: null;
readonly boolean: {};
readonly date: {};
readonly dateRange: null;
readonly datetime: {};
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly number: {
readonly blob: null;
readonly boolean: {};
readonly date: {};
readonly dateRange: null;
readonly datetime: {};
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: null;
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly object: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: null;
readonly markdown: null;
readonly string: null;
readonly url: null;
};
readonly reference: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: {
readonly field: {
readonly type: "sourceField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field of the referenced entry to use for the string value.";
readonly required: true;
};
};
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: {
readonly sideIds: {
readonly type: "sideIdOfSameCollection";
readonly description: "If specified, only the references kept in sync in the specified link sides will be evaluated. An empty array means no side will be evaluated.";
readonly isArray: true;
readonly defaults: [{
readonly value: readonly [];
}];
};
readonly type: {
readonly type: "enum";
readonly description: "The type of mapping, as selected by the customer.";
readonly hidden: true;
readonly isArray: false;
readonly values: ["manualOnly", "referenceOnly"];
readonly required: true;
};
};
readonly html: {
readonly field: {
readonly type: "sourceField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field of the referenced entry to use for the string value.";
readonly required: true;
};
};
readonly markdown: {
readonly field: {
readonly type: "sourceField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field of the referenced entry to use for the string value.";
readonly required: true;
};
};
readonly string: {
readonly field: {
readonly type: "sourceField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field of the referenced entry to use for the string value.";
readonly required: true;
};
};
readonly url: null;
};
readonly html: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: {
readonly decoratorTemplate: {
readonly type: "stringWithSourceItemFields";
readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
}];
readonly hidden: true;
};
readonly decoratorPrefix: {
readonly type: "string";
readonly description: "Prefix for the decorator. Defaults to \"➤\".";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "➤";
}];
readonly hidden: true;
};
};
readonly markdown: {
readonly decoratorTemplate: {
readonly type: "stringWithSourceItemFields";
readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "On <strong>{semantic:createdAt}</strong>, <em>{semantic:user.fields.semantic:displayName}</em> commented:";
}];
readonly hidden: true;
};
readonly decoratorPrefix: {
readonly type: "string";
readonly description: "Prefix for the decorator. Defaults to \"➤\".";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "➤";
}];
readonly hidden: true;
};
};
readonly string: {};
readonly url: null;
};
readonly markdown: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: {
readonly decoratorTemplate: {
readonly type: "stringWithSourceItemFields";
readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
}];
readonly hidden: true;
};
readonly decoratorPrefix: {
readonly type: "string";
readonly description: "Prefix for the decorator. Defaults to \"➤\".";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "➤";
}];
readonly hidden: true;
};
};
readonly markdown: {
readonly decoratorTemplate: {
readonly type: "stringWithSourceItemFields";
readonly description: "Template for the decorator. Use {author} and {date} placeholders.";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "On **{semantic:createdAt}**, __{semantic:user.fields.semantic:displayName}__ commented:";
}];
readonly hidden: true;
};
readonly decoratorPrefix: {
readonly type: "string";
readonly description: "Prefix for the decorator. Defaults to \"➤\".";
readonly defaults: [{
readonly sourceRelationSemantic: "comments";
readonly sourceFieldSemantic: "description";
readonly targetRelationSemantic: "comments";
readonly targetFieldSemantic: "description";
readonly value: "➤";
}];
readonly hidden: true;
};
};
readonly string: {};
readonly url: null;
};
readonly string: {
readonly blob: null;
readonly boolean: {};
readonly date: {};
readonly dateRange: null;
readonly datetime: {};
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: {};
readonly number: {};
readonly object: null;
readonly reference: {
readonly field: {
readonly type: "targetField";
readonly defaults: [{
readonly value: "semantic:displayName";
}];
readonly description: "The field against which to match the string value.";
readonly required: true;
};
};
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: null;
};
readonly url: {
readonly blob: null;
readonly boolean: null;
readonly date: null;
readonly dateRange: null;
readonly datetime: null;
readonly datetimeRange: null;
readonly duration: null;
readonly email: null;
readonly integer: null;
readonly number: null;
readonly object: null;
readonly reference: null;
readonly html: {};
readonly markdown: {};
readonly string: {};
readonly url: {};
};
};