BokaMera.API.Host

DeleteNewsletterTemplate

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

The following routes are available for this service:
DELETE	/newsletter/templates/{Id}	Delete a company newsletter template.	Delete a company newsletter template.

import 'package:servicestack/servicestack.dart';

class NewsletterSendMethodQueryResponse implements IConvertible
{
    /**
    * The send method id
    */
    // @ApiMember(Description="The send method id")
    int? Id;

    /**
    * The send method name.
    */
    // @ApiMember(Description="The send method name.")
    String? Name;

    /**
    * The send method description.
    */
    // @ApiMember(Description="The send method description.")
    String? Description;

    NewsletterSendMethodQueryResponse({this.Id,this.Name,this.Description});
    NewsletterSendMethodQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class NewsletterEmailTemplatesQueryResponse implements IConvertible
{
    /**
    * The email template id
    */
    // @ApiMember(Description="The email template id")
    int? Id;

    /**
    * The email template name.
    */
    // @ApiMember(Description="The email template name.")
    String? Name;

    /**
    * The email template description.
    */
    // @ApiMember(Description="The email template description.")
    String? Description;

    /**
    * The email template html content.
    */
    // @ApiMember(Description="The email template html content.")
    String? Body;

    NewsletterEmailTemplatesQueryResponse({this.Id,this.Name,this.Description,this.Body});
    NewsletterEmailTemplatesQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'Description': Description,
        'Body': Body
    };

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

class NewsletterTemplatesQueryResponse implements IConvertible
{
    /**
    * The newsletter template id
    */
    // @ApiMember(Description="The newsletter template id")
    int? Id;

    /**
    * The newsletter template heading.
    */
    // @ApiMember(Description="The newsletter template heading.")
    String? Heading;

    /**
    * The newsletter template body.
    */
    // @ApiMember(Description="The newsletter template body.")
    String? Body;

    /**
    * The email template the newsletter uses.
    */
    // @ApiMember(Description="The email template the newsletter uses.")
    int? EmailTemplateId;

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

    /**
    * The newsletter template image url.
    */
    // @ApiMember(Description="The newsletter template image url.")
    String? ImageUrl;

    /**
    * The newsletter created date.
    */
    // @ApiMember(Description="The newsletter created date.")
    DateTime? Created;

    /**
    * Send method information.
    */
    // @ApiMember(Description="Send method information.")
    NewsletterSendMethodQueryResponse? SendMethodInformation;

    /**
    * Email template information.
    */
    // @ApiMember(Description="Email template information.")
    NewsletterEmailTemplatesQueryResponse? EmailTemplateInformation;

    NewsletterTemplatesQueryResponse({this.Id,this.Heading,this.Body,this.EmailTemplateId,this.SendMethodId,this.ImageUrl,this.Created,this.SendMethodInformation,this.EmailTemplateInformation});
    NewsletterTemplatesQueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Heading = json['Heading'];
        Body = json['Body'];
        EmailTemplateId = json['EmailTemplateId'];
        SendMethodId = json['SendMethodId'];
        ImageUrl = json['ImageUrl'];
        Created = JsonConverters.fromJson(json['Created'],'DateTime',context!);
        SendMethodInformation = JsonConverters.fromJson(json['SendMethodInformation'],'NewsletterSendMethodQueryResponse',context!);
        EmailTemplateInformation = JsonConverters.fromJson(json['EmailTemplateInformation'],'NewsletterEmailTemplatesQueryResponse',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Heading': Heading,
        'Body': Body,
        'EmailTemplateId': EmailTemplateId,
        'SendMethodId': SendMethodId,
        'ImageUrl': ImageUrl,
        'Created': JsonConverters.toJson(Created,'DateTime',context!),
        'SendMethodInformation': JsonConverters.toJson(SendMethodInformation,'NewsletterSendMethodQueryResponse',context!),
        'EmailTemplateInformation': JsonConverters.toJson(EmailTemplateInformation,'NewsletterEmailTemplatesQueryResponse',context!)
    };

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

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class DeleteNewsletterTemplate 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 newsletter template id.
    */
    // @ApiMember(Description="The newsletter template id.", IsRequired=true, ParameterType="path")
    int? Id;

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

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

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

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

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

Dart DeleteNewsletterTemplate 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

HTTP + JSON

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

DELETE /newsletter/templates/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"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"}}