1Fetch Client API

SubscriptionEvents

The following routes are available for this service:
GET	/subscription/events	Get a list of subscription event types

import 'package:servicestack/servicestack.dart';

class ApiServiceRequest implements IServiceRequest, IHasApiKey, IConvertible
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    String? ApiKey;

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

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

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

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

class ApiServiceResponse implements IServiceResponse, IConvertible
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    String? Description;

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    String? Heading;

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    bool? WasSuccessful;

    ApiServiceResponse({this.Description,this.Heading,this.WasSuccessful});
    ApiServiceResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class WebhookSubscriptionEventType
{
    static const WebhookSubscriptionEventType DriverOnTheWay = const WebhookSubscriptionEventType._(0);
    static const WebhookSubscriptionEventType ArrivedAtWaypoint = const WebhookSubscriptionEventType._(1);
    static const WebhookSubscriptionEventType DepartedWaypoint = const WebhookSubscriptionEventType._(2);
    static const WebhookSubscriptionEventType OrderCompleted = const WebhookSubscriptionEventType._(3);
    static const WebhookSubscriptionEventType OrderCancelled = const WebhookSubscriptionEventType._(4);

    final int _value;
    const WebhookSubscriptionEventType._(this._value);
    int get value => _value;
    static List<WebhookSubscriptionEventType> get values => const [DriverOnTheWay,ArrivedAtWaypoint,DepartedWaypoint,OrderCompleted,OrderCancelled];
}

class SubscriptionEventsDescription implements IConvertible
{
    WebhookSubscriptionEventType? EventType;
    String? EventName;
    String? EventDescription;

    SubscriptionEventsDescription({this.EventType,this.EventName,this.EventDescription});
    SubscriptionEventsDescription.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        EventType = JsonConverters.fromJson(json['EventType'],'WebhookSubscriptionEventType',context!);
        EventName = json['EventName'];
        EventDescription = json['EventDescription'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'EventType': JsonConverters.toJson(EventType,'WebhookSubscriptionEventType',context!),
        'EventName': EventName,
        'EventDescription': EventDescription
    };

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

class SubscriptionEventsResponse extends ApiServiceResponse implements IConvertible
{
    List<SubscriptionEventsDescription>? SubscriptionEventsDescriptions;

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

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        SubscriptionEventsDescriptions = JsonConverters.fromJson(json['SubscriptionEventsDescriptions'],'List<SubscriptionEventsDescription>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SubscriptionEventsDescriptions': JsonConverters.toJson(SubscriptionEventsDescriptions,'List<SubscriptionEventsDescription>',context!)
    });

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

class SubscriptionEvents extends ApiServiceRequest implements IConvertible
{
    SubscriptionEvents();
    SubscriptionEvents.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "SubscriptionEvents";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: '1fetch.api.client.prod.86degrees.com', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'WebhookSubscriptionEventType': TypeInfo(TypeOf.Enum, enumValues:WebhookSubscriptionEventType.values),
    'SubscriptionEventsDescription': TypeInfo(TypeOf.Class, create:() => SubscriptionEventsDescription()),
    'SubscriptionEventsResponse': TypeInfo(TypeOf.Class, create:() => SubscriptionEventsResponse()),
    'List<SubscriptionEventsDescription>': TypeInfo(TypeOf.Class, create:() => <SubscriptionEventsDescription>[]),
    'SubscriptionEvents': TypeInfo(TypeOf.Class, create:() => SubscriptionEvents()),
});

Dart SubscriptionEvents 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.

GET /subscription/events HTTP/1.1 
Host: 1fetch.api.client.prod.86degrees.com 
Accept: application/json

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

{"SubscriptionEventsDescriptions":[{"EventType":0,"EventName":"String","EventDescription":"String"}],"Description":"String","Heading":"String","WasSuccessful":false}