| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
"use strict";
export class QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code> */
Skip;
/**
* @type {?number}
* @description Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code> */
Take;
/**
* @type {string}
* @description Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code> */
OrderBy;
/**
* @type {string}
* @description Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code> */
OrderByDesc;
/**
* @type {string}
* @description Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code> */
Include;
/** @type {string} */
Fields;
/** @type {{ [index: string]: string; }} */
Meta;
}
/** @typedef From {any} */
/** @typedef Into {any} */
export class QueryDb extends QueryBase {
/** @param {{Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class NewsletterSendMethodQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The send method id */
Id;
/**
* @type {string}
* @description The send method name. */
Name;
/**
* @type {string}
* @description The send method description. */
Description;
}
export class NewsletterEmailTemplatesQueryResponse {
/** @param {{Id?:number,Name?:string,Description?:string,Body?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The email template id */
Id;
/**
* @type {string}
* @description The email template name. */
Name;
/**
* @type {string}
* @description The email template description. */
Description;
/**
* @type {string}
* @description The email template html content. */
Body;
}
export class NewsletterTemplatesQueryResponse {
/** @param {{Id?:number,Heading?:string,Body?:string,EmailTemplateId?:number,SendMethodId?:number,ImageUrl?:string,Created?:string,SendMethodInformation?:NewsletterSendMethodQueryResponse,EmailTemplateInformation?:NewsletterEmailTemplatesQueryResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description The newsletter template id */
Id;
/**
* @type {string}
* @description The newsletter template heading. */
Heading;
/**
* @type {string}
* @description The newsletter template body. */
Body;
/**
* @type {?number}
* @description The email template the newsletter uses. */
EmailTemplateId;
/**
* @type {number}
* @description Send Method. 1 = Email, 2 = SMS */
SendMethodId;
/**
* @type {string}
* @description The newsletter template image url. */
ImageUrl;
/**
* @type {string}
* @description The newsletter created date. */
Created;
/**
* @type {NewsletterSendMethodQueryResponse}
* @description Send method information. */
SendMethodInformation;
/**
* @type {NewsletterEmailTemplatesQueryResponse}
* @description Email template information. */
EmailTemplateInformation;
}
export class BaseModel {
constructor(init) { Object.assign(this, init) }
}
export class SendMethod extends BaseModel {
/** @param {{Name?:string,Description?:string,ModifiedDate?:string,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {?string} */
ModifiedDate;
/** @type {number} */
Id;
}
export class EmailTemplate extends BaseModel {
/** @param {{Name?:string,Description?:string,Body?:string,Type?:number,ModifiedDate?:string,Id?:number}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Name;
/** @type {string} */
Description;
/** @type {string} */
Body;
/** @type {number} */
Type;
/** @type {?string} */
ModifiedDate;
/** @type {number} */
Id;
}
export class NewsletterTemplate extends BaseModel {
/** @param {{SendMethod?:SendMethod,EmailTemplate?:EmailTemplate,CompanyId?:string,Id?:number,Heading?:string,Body?:string,ImageUrl?:string,SendMethodId?:number,EmailTemplateId?:number,Created?:string,ModifiedDate?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {SendMethod} */
SendMethod;
/** @type {EmailTemplate} */
EmailTemplate;
/** @type {string} */
CompanyId;
/** @type {number} */
Id;
/** @type {string} */
Heading;
/** @type {string} */
Body;
/** @type {string} */
ImageUrl;
/** @type {number} */
SendMethodId;
/** @type {?number} */
EmailTemplateId;
/** @type {string} */
Created;
/** @type {?string} */
ModifiedDate;
}
export class NewsletterTemplatesQuery extends QueryDb {
/** @param {{CompanyId?:string,Id?:number,IncludeSendMethodInformation?:boolean,IncludeEmailTemplateInformation?:boolean,Skip?:number,Take?:number,OrderBy?:string,OrderByDesc?:string,Include?:string,Fields?:string,Meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {?number}
* @description The newsletter template id. */
Id;
/**
* @type {boolean}
* @description If you want to include the message send method information */
IncludeSendMethodInformation;
/**
* @type {boolean}
* @description If you want to include the email template information */
IncludeEmailTemplateInformation;
}
export class AccessKeyTypeResponse {
/** @param {{Id?:number,KeyType?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
KeyType;
/** @type {string} */
Description;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{Offset?:number,Total?:number,Results?:T[],Meta?:{ [index: string]: string; },ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Offset;
/** @type {number} */
Total;
/** @type {T[]} */
Results;
/** @type {{ [index: string]: string; }} */
Meta;
/** @type {ResponseStatus} */
ResponseStatus;
}
JavaScript NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /newsletter/templates HTTP/1.1 Host: testapi.bokamera.se Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Heading":"String","Body":"String","EmailTemplateId":0,"SendMethodId":0,"ImageUrl":"String","SendMethodInformation":{"Id":0,"Name":"String","Description":"String"},"EmailTemplateInformation":{"Id":0,"Name":"String","Description":"String","Body":"String"}}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}