1Fetch Client API

<back to all web services

SubscriptionList

import Foundation
import ServiceStack

public class SubscriptionList : 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 SubscriptionListResponse : ApiServiceResponse
{
    public var subscriptions:[SubscriptionDetail] = []

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

    private enum CodingKeys : String, CodingKey {
        case subscriptions
    }

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

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

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 SubscriptionDetail : Codable
{
    public var eventType:WebhookSubscriptionEventType
    public var eventName:String
    public var subscriptionUrl: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 SubscriptionList DTOs

GET /subscription HTTP/1.1 
Host: api.1fetch.co.za 
Accept: text/jsv

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

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