| GET, POST | /{Brand}/templates | ||
|---|---|---|---|
| All Verbs | /kyocera/{Template*} | ||
| All Verbs | /ta/{Template*} | ||
| All Verbs | /utax/{Template*} |
"use strict";
/** @typedef {'Desktop'|'Hp'|'Kyocera'|'NeaScan'|'Samsung'|'FujiXerox'|'Ta'|'Utax'|'Epson'|'ScanFront400'|'Sharp'|'Ricoh'|'FujiFilm'} */
export var Brand;
(function (Brand) {
Brand["Desktop"] = "Desktop"
Brand["Hp"] = "Hp"
Brand["Kyocera"] = "Kyocera"
Brand["NeaScan"] = "NeaScan"
Brand["Samsung"] = "Samsung"
Brand["FujiXerox"] = "FujiXerox"
Brand["Ta"] = "Ta"
Brand["Utax"] = "Utax"
Brand["Epson"] = "Epson"
Brand["ScanFront400"] = "ScanFront400"
Brand["Sharp"] = "Sharp"
Brand["Ricoh"] = "Ricoh"
Brand["FujiFilm"] = "FujiFilm"
})(Brand || (Brand = {}));
export class DtoBase {
/** @param {{Brand?:Brand}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Brand} */
Brand;
}
export class RequestBase extends DtoBase {
/** @param {{Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GetTemplates extends RequestBase {
/** @param {{Template?:string,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Template;
}
export class ResponseBase extends DtoBase {
/** @param {{SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
SelectedUiLanguage;
/** @type {string} */
svSession;
/** @type {string} */
Title;
/** @type {string} */
PageTip;
/** @type {boolean} */
NewBrowser;
/** @type {boolean} */
ScanFront400TA;
/** @type {boolean} */
ScanFront400UTAX;
}
/** @typedef {'Workflow'|'FreeForm'} */
export var TemplateType;
(function (TemplateType) {
TemplateType["Workflow"] = "Workflow"
TemplateType["FreeForm"] = "FreeForm"
})(TemplateType || (TemplateType = {}));
/** @typedef {'Interval'|'Fixed'} */
export var TemplateScheduleType;
(function (TemplateScheduleType) {
TemplateScheduleType["Interval"] = "Interval"
TemplateScheduleType["Fixed"] = "Fixed"
})(TemplateScheduleType || (TemplateScheduleType = {}));
/** @typedef {'Default'|'Dpi100'|'Dpi150'|'Dpi200'|'Dpi300'|'Dpi400'|'Dpi500'|'Dpi600'} */
export var PdfLoadResolution;
(function (PdfLoadResolution) {
PdfLoadResolution["Default"] = "Default"
PdfLoadResolution["Dpi100"] = "Dpi100"
PdfLoadResolution["Dpi150"] = "Dpi150"
PdfLoadResolution["Dpi200"] = "Dpi200"
PdfLoadResolution["Dpi300"] = "Dpi300"
PdfLoadResolution["Dpi400"] = "Dpi400"
PdfLoadResolution["Dpi500"] = "Dpi500"
PdfLoadResolution["Dpi600"] = "Dpi600"
})(PdfLoadResolution || (PdfLoadResolution = {}));
/** @typedef {'FailureOnly'|'SuccessOnly'|'Always'} */
export var NotificationType;
(function (NotificationType) {
NotificationType["FailureOnly"] = "FailureOnly"
NotificationType["SuccessOnly"] = "SuccessOnly"
NotificationType["Always"] = "Always"
})(NotificationType || (NotificationType = {}));
export class GetTemplatesResponse extends ResponseBase {
/** @param {{Templates?:IList<IClientTemplate>,SelectedUiLanguage?:string,svSession?:string,Title?:string,PageTip?:string,NewBrowser?:boolean,ScanFront400TA?:boolean,ScanFront400UTAX?:boolean,Brand?:Brand}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {IList<IClientTemplate>} */
Templates;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /{Brand}/templates HTTP/1.1
Host: buildmax.org
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"Template":"String","Brand":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{Unable to show example output for type 'GetTemplatesResponse' using the custom 'other' filter}No parameterless constructor defined for this object.