Billiecart API

<back to all web services

DeliverEmailRequest

Requires Authentication
Required role:service
The following routes are available for this service:
POST/emails/deliver
import 'package:servicestack/servicestack.dart';

abstract class PostOperationUnTenanted<TResponse> implements IPost
{
    PostOperationUnTenanted();
    PostOperationUnTenanted.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "PostOperationUnTenanted<$TResponse>";
    TypeContext? context = _ctx;
}

class DeliverEmailResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    bool? isDelivered;

    DeliverEmailResponse({this.responseStatus,this.isDelivered});
    DeliverEmailResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        isDelivered = json['isDelivered'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'isDelivered': isDelivered
    };

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

class DeliverEmailRequest extends PostOperationUnTenanted<DeliverEmailResponse> implements IConvertible
{
    String? message;

    DeliverEmailRequest({this.message});
    DeliverEmailRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'message': message
    });

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

TypeContext _ctx = TypeContext(library: 'staging_api.billiecart.com.au', types: <String, TypeInfo> {
    'PostOperationUnTenanted<TResponse>': TypeInfo(TypeOf.AbstractClass),
    'DeliverEmailResponse': TypeInfo(TypeOf.Class, create:() => DeliverEmailResponse()),
    'DeliverEmailRequest': TypeInfo(TypeOf.Class, create:() => DeliverEmailRequest()),
});

Dart DeliverEmailRequest 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 /emails/deliver HTTP/1.1 
Host: staging-api.billiecart.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	message: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	isDelivered: False
}