1Fetch Client API

SubscriptionList

The following routes are available for this service:
GET	/subscription	Get a list of subscription events that you are subscribed to

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 SubscriptionDetail implements IConvertible
{
    WebhookSubscriptionEventType? EventType;
    String? EventName;
    String? SubscriptionUrl;

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

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

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

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

class SubscriptionListResponse extends ApiServiceResponse implements IConvertible
{
    List<SubscriptionDetail>? Subscriptions;

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

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

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

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

class SubscriptionList extends ApiServiceRequest implements IConvertible
{
    SubscriptionList();
    SubscriptionList.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() => "SubscriptionList";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.1fetch.co.za', types: <String, TypeInfo> {
    'ApiServiceRequest': TypeInfo(TypeOf.Class, create:() => ApiServiceRequest()),
    'ApiServiceResponse': TypeInfo(TypeOf.Class, create:() => ApiServiceResponse()),
    'WebhookSubscriptionEventType': TypeInfo(TypeOf.Enum, enumValues:WebhookSubscriptionEventType.values),
    'SubscriptionDetail': TypeInfo(TypeOf.Class, create:() => SubscriptionDetail()),
    'SubscriptionListResponse': TypeInfo(TypeOf.Class, create:() => SubscriptionListResponse()),
    'List<SubscriptionDetail>': TypeInfo(TypeOf.Class, create:() => <SubscriptionDetail>[]),
    'SubscriptionList': TypeInfo(TypeOf.Class, create:() => SubscriptionList()),
});

Dart SubscriptionList DTOs

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

HTTP + XML

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

GET /subscription HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<SubscriptionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel">
  <Description xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Description>
  <Heading xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">String</Heading>
  <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/WebService.ClientServiceModel.Base">false</WasSuccessful>
  <Subscriptions>
    <SubscriptionDetail>
      <EventName>String</EventName>
      <EventType>DriverOnTheWay</EventType>
      <SubscriptionUrl>String</SubscriptionUrl>
    </SubscriptionDetail>
  </Subscriptions>
</SubscriptionListResponse>