BokaMera.API.Host

TestSendNewsLetter

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/newsletter/templates/test	Test to send a newsletter to a Email or Mobile phone recepient using SMS.

import 'package:servicestack/servicestack.dart';

class NewsletterLogQueryResponse implements IConvertible
{
    /**
    * The message log id
    */
    // @ApiMember(Description="The message log id")
    int? Id;

    /**
    * The message receiver. Either a email or a mobile phone number.
    */
    // @ApiMember(Description="The message receiver. Either a email or a mobile phone number.")
    String? Receiver;

    /**
    * Nessage Title.
    */
    // @ApiMember(Description="Nessage Title.")
    String? MessageTitle;

    /**
    * Nessage Body.
    */
    // @ApiMember(Description="Nessage Body.")
    String? MessageBody;

    /**
    * When message was created.
    */
    // @ApiMember(Description="When message was created.")
    DateTime? Created;

    /**
    * When the message will be sent.
    */
    // @ApiMember(Description="When the message will be sent.")
    DateTime? ToSendDate;

    /**
    * When the message was sent.
    */
    // @ApiMember(Description="When the message was sent.")
    DateTime? SentDate;

    /**
    * If Message is sent
    */
    // @ApiMember(Description="If Message is sent")
    bool? Sent;

    /**
    * Number of retries to send the message
    */
    // @ApiMember(Description="Number of retries to send the message")
    int? MessageRetries;

    /**
    * Send Method. 1 = Email, 2 = SMS
    */
    // @ApiMember(Description="Send Method. 1 = Email, 2 = SMS")
    int? SendMethodId;

    NewsletterLogQueryResponse({this.Id,this.Receiver,this.MessageTitle,this.MessageBody,this.Created,this.ToSendDate,this.SentDate,this.Sent,this.MessageRetries,this.SendMethodId});
    NewsletterLogQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Receiver = json['Receiver'];
        MessageTitle = json['MessageTitle'];
        MessageBody = json['MessageBody'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        ToSendDate = JsonConverters.fromJson(json['ToSendDate'],'DateTime',context!);
        SentDate = JsonConverters.fromJson(json['SentDate'],'DateTime',context!);
        Sent = json['Sent'];
        MessageRetries = json['MessageRetries'];
        SendMethodId = json['SendMethodId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Receiver': Receiver,
        'MessageTitle': MessageTitle,
        'MessageBody': MessageBody,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'ToSendDate': JsonConverters.toJson(ToSendDate,'DateTime',context!),
        'SentDate': JsonConverters.toJson(SentDate,'DateTime',context!),
        'Sent': Sent,
        'MessageRetries': MessageRetries,
        'SendMethodId': SendMethodId
    };

    getTypeName() => "NewsletterLogQueryResponse";
    TypeContext? context = _ctx;
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class TestSendNewsLetter implements ICompany, IConvertible
{
    /**
    * The company id, if empty will use the company id for the user you are logged in with.
    */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    String? CompanyId;

    /**
    * The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.
    */
    // @ApiMember(Description="The email recepient to receive the newsletter. For templates with send method SMS you need to enter a valid mobile phone number and send method Email a valid Email must be provided.", IsRequired=true)
    String? Receiver;

    /**
    * The newsletter template id.
    */
    // @ApiMember(Description="The newsletter template id.", IsRequired=true)
    int? Id;

    TestSendNewsLetter({this.CompanyId,this.Receiver,this.Id});
    TestSendNewsLetter.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Receiver = json['Receiver'];
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Receiver': Receiver,
        'Id': Id
    };

    getTypeName() => "TestSendNewsLetter";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bokamera.se', types: <String, TypeInfo> {
    'NewsletterLogQueryResponse': TypeInfo(TypeOf.Class, create:() => NewsletterLogQueryResponse()),
    'TestSendNewsLetter': TypeInfo(TypeOf.Class, create:() => TestSendNewsLetter()),
});

Dart TestSendNewsLetter DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /newsletter/templates/test HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Receiver: String,
	Id: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Receiver: String,
	MessageTitle: String,
	MessageBody: String,
	SentDate: "0001-01-01T00:00:00",
	Sent: False,
	MessageRetries: 0,
	SendMethodId: 0
}