1Fetch Client API

<back to all web services

SubscriptionList

The following routes are available for this service:
GET/subscriptionGet a list of subscription events that you are subscribed to
"use strict";
export class ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The API Key required for authentication */
    ApiKey;
}
export class ApiServiceResponse {
    /** @param {{Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Information about the response. */
    Description;
    /**
     * @type {string}
     * @description Heading or summary of the response. */
    Heading;
    /**
     * @type {boolean}
     * @description Did the intended operation for this response complete successfully? */
    WasSuccessful;
}
/** @typedef {number} */
export var WebhookSubscriptionEventType;
(function (WebhookSubscriptionEventType) {
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["DriverOnTheWay"] = 0] = "DriverOnTheWay"
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["ArrivedAtWaypoint"] = 1] = "ArrivedAtWaypoint"
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["DepartedWaypoint"] = 2] = "DepartedWaypoint"
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["OrderCompleted"] = 3] = "OrderCompleted"
    WebhookSubscriptionEventType[WebhookSubscriptionEventType["OrderCancelled"] = 4] = "OrderCancelled"
})(WebhookSubscriptionEventType || (WebhookSubscriptionEventType = {}));
export class SubscriptionDetail {
    /** @param {{EventType?:WebhookSubscriptionEventType,EventName?:string,SubscriptionUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WebhookSubscriptionEventType} */
    EventType;
    /** @type {string} */
    EventName;
    /** @type {string} */
    SubscriptionUrl;
}
export class SubscriptionListResponse extends ApiServiceResponse {
    /** @param {{Subscriptions?:SubscriptionDetail[],Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SubscriptionDetail[]} */
    Subscriptions;
}
export class SubscriptionList extends ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript SubscriptionList DTOs

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

HTTP + OTHER

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: text/jsonl

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

{"Subscriptions":[{"EventType":0,"EventName":"String","SubscriptionUrl":"String"}],"Description":"String","Heading":"String","WasSuccessful":false}