| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /newsletter/templates | Get company newsletter templates | Get all company newsletter templates. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
skip: Optional[int] = None
"""
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>
"""
take: Optional[int] = None
"""
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>
"""
order_by: Optional[str] = None
"""
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>
"""
order_by_desc: Optional[str] = None
"""
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>
"""
include: Optional[str] = None
"""
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>
"""
fields: Optional[str] = None
meta: Optional[Dict[str, str]] = None
From = TypeVar('From')
Into = TypeVar('Into')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb2(Generic[From, Into], QueryBase, IReturn[QueryResponse[Into]]):
@staticmethod
def response_type(): return QueryResponse[Into]
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterSendMethodQueryResponse:
# @ApiMember(Description="The send method id")
id: int = 0
"""
The send method id
"""
# @ApiMember(Description="The send method name.")
name: Optional[str] = None
"""
The send method name.
"""
# @ApiMember(Description="The send method description.")
description: Optional[str] = None
"""
The send method description.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterEmailTemplatesQueryResponse:
# @ApiMember(Description="The email template id")
id: int = 0
"""
The email template id
"""
# @ApiMember(Description="The email template name.")
name: Optional[str] = None
"""
The email template name.
"""
# @ApiMember(Description="The email template description.")
description: Optional[str] = None
"""
The email template description.
"""
# @ApiMember(Description="The email template html content.")
body: Optional[str] = None
"""
The email template html content.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterTemplatesQueryResponse:
# @ApiMember(Description="The newsletter template id")
id: int = 0
"""
The newsletter template id
"""
# @ApiMember(Description="The newsletter template heading.")
heading: Optional[str] = None
"""
The newsletter template heading.
"""
# @ApiMember(Description="The newsletter template body.")
body: Optional[str] = None
"""
The newsletter template body.
"""
# @ApiMember(Description="The email template the newsletter uses.")
email_template_id: Optional[int] = None
"""
The email template the newsletter uses.
"""
# @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
send_method_id: int = 0
"""
Send Method. 1 = Email, 2 = SMS
"""
# @ApiMember(Description="The newsletter template image url.")
image_url: Optional[str] = None
"""
The newsletter template image url.
"""
# @ApiMember(Description="The newsletter created date.")
created: datetime.datetime = datetime.datetime(1, 1, 1)
"""
The newsletter created date.
"""
# @ApiMember(Description="Send method information.")
send_method_information: Optional[NewsletterSendMethodQueryResponse] = None
"""
Send method information.
"""
# @ApiMember(Description="Email template information.")
email_template_information: Optional[NewsletterEmailTemplatesQueryResponse] = None
"""
Email template information.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SendMethod(BaseModel):
# @Required()
name: Optional[str] = None
# @Required()
description: Optional[str] = None
modified_date: Optional[datetime.datetime] = None
id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EmailTemplate(BaseModel):
# @Required()
name: Optional[str] = None
# @Required()
description: Optional[str] = None
# @Required()
body: Optional[str] = None
# @Required()
type: int = 0
modified_date: Optional[datetime.datetime] = None
id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterTemplate(BaseModel):
send_method: Optional[SendMethod] = None
email_template: Optional[EmailTemplate] = None
# @Required()
company_id: Optional[str] = None
id: int = 0
# @Required()
heading: Optional[str] = None
# @Required()
body: Optional[str] = None
image_url: Optional[str] = None
# @Required()
send_method_id: int = 0
email_template_id: Optional[int] = None
# @Required()
created: datetime.datetime = datetime.datetime(1, 1, 1)
modified_date: Optional[datetime.datetime] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NewsletterTemplatesQuery(QueryDb2[NewsletterTemplate, NewsletterTemplatesQueryResponse], ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The newsletter template id.")
id: Optional[int] = None
"""
The newsletter template id.
"""
# @ApiMember(DataType="boolean", Description="If you want to include the message send method information", ParameterType="query")
include_send_method_information: bool = False
"""
If you want to include the message send method information
"""
# @ApiMember(DataType="boolean", Description="If you want to include the email template information", ParameterType="query")
include_email_template_information: bool = False
"""
If you want to include the email template information
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
id: int = 0
key_type: Optional[str] = None
description: Optional[str] = None
AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[AccessKeyTypeResponse]):
offset: int = 0
total: int = 0
results: Optional[List[AccessKeyTypeResponse]] = None
meta: Optional[Dict[str, str]] = None
response_status: Optional[ResponseStatus] = None
Python NewsletterTemplatesQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: api.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}