1Fetch Client API

SubscriptionEvents

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

"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 SubscriptionEventsDescription {
    /** @param {{EventType?:WebhookSubscriptionEventType,EventName?:string,EventDescription?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {WebhookSubscriptionEventType} */
    EventType;
    /** @type {string} */
    EventName;
    /** @type {string} */
    EventDescription;
}
export class SubscriptionEventsResponse extends ApiServiceResponse {
    /** @param {{SubscriptionEventsDescriptions?:SubscriptionEventsDescription[],Description?:string,Heading?:string,WasSuccessful?:boolean}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {SubscriptionEventsDescription[]} */
    SubscriptionEventsDescriptions;
}
export class SubscriptionEvents extends ApiServiceRequest {
    /** @param {{ApiKey?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript SubscriptionEvents 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/events HTTP/1.1 
Host: api.1fetch.co.za 
Accept: application/xml

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

<SubscriptionEventsResponse 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>
  <SubscriptionEventsDescriptions>
    <SubscriptionEventsDescription>
      <EventDescription>String</EventDescription>
      <EventName>String</EventName>
      <EventType>DriverOnTheWay</EventType>
    </SubscriptionEventsDescription>
  </SubscriptionEventsDescriptions>
</SubscriptionEventsResponse>