1Fetch Client API

SubscriptionEvents

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

import Foundation
import ServiceStack

public class SubscriptionEvents : ApiServiceRequest
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class ApiServiceRequest : IServiceRequest, IHasApiKey, Codable
{
    /**
    * The API Key required for authentication
    */
    // @ApiMember(DataType="string", Description="The API Key required for authentication", IsRequired=true)
    public var apiKey:String

    required public init(){}
}

public class SubscriptionEventsResponse : ApiServiceResponse
{
    public var subscriptionEventsDescriptions:[SubscriptionEventsDescription] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case subscriptionEventsDescriptions
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        subscriptionEventsDescriptions = try container.decodeIfPresent([SubscriptionEventsDescription].self, forKey: .subscriptionEventsDescriptions) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if subscriptionEventsDescriptions.count > 0 { try container.encode(subscriptionEventsDescriptions, forKey: .subscriptionEventsDescriptions) }
    }
}

public class ApiServiceResponse : IServiceResponse, Codable
{
    /**
    * Information about the response.
    */
    // @ApiMember(Description="Information about the response.", IsRequired=true)
    public var Description:String

    /**
    * Heading or summary of the response.
    */
    // @ApiMember(Description="Heading or summary of the response.", IsRequired=true)
    public var heading:String

    /**
    * Did the intended operation for this response complete successfully?
    */
    // @ApiMember(DataType="boolean", Description="Did the intended operation for this response complete successfully?", IsRequired=true)
    public var wasSuccessful:Bool

    required public init(){}
}

public class SubscriptionEventsDescription : Codable
{
    public var eventType:WebhookSubscriptionEventType
    public var eventName:String
    public var eventDescription:String

    required public init(){}
}

public enum WebhookSubscriptionEventType : Int, Codable
{
    case DriverOnTheWay = 0
    case ArrivedAtWaypoint = 1
    case DepartedWaypoint = 2
    case OrderCompleted = 3
    case OrderCancelled = 4
}

Swift 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}