| DELETE | /subscription/{EventType} | Unsubscribe from an event notification | |
|---|---|---|---|
| DELETE | /subscription | Unsubscribe from an event notification |
"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 DeleteSubscription extends ApiServiceRequest {
/** @param {{EventType?:WebhookSubscriptionEventType,ApiKey?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {WebhookSubscriptionEventType}
* @description The event type being removed */
EventType;
}
JavaScript DeleteSubscription DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
DELETE /subscription/{EventType} HTTP/1.1
Host: api.1fetch.co.za
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Description":"String","Heading":"String","WasSuccessful":false}