ClubReady Api

<back to all web services

CreditDetailRequest

import Foundation
import ServiceStack

public class CreditDetailRequest : ApiDtoBase, IRestrictedApiRequest
{
    /**
    * Api Key - grants access to resources
    */
    // @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
    public var apiKey:String

    /**
    * Chain ID
    */
    // @ApiMember(DataType="integer", Description="Chain ID", Name="ChainId", ParameterType="query")
    public var chainId:Int?

    /**
    * Store ID
    */
    // @ApiMember(DataType="integer", Description="Store ID", Name="StoreId", ParameterType="query")
    public var storeId:Int?

    /**
    * ClubReady User ID
    */
    // @ApiMember(DataType="integer", Description="ClubReady User ID", IsRequired=true, Name="UserId", ParameterType="path")
    public var userId:Int

    /**
    * Determines if the list of the user's credits are broken out by store ID.
    */
    // @ApiMember(DataType="Boolean", Description="Determines if the list of the user's credits are broken out by store ID.", Name="FullDetail", ParameterType="query")
    public var fullDetail:Bool

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case chainId
        case storeId
        case userId
        case fullDetail
        case restrictedId
        case restrictedResourceType
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        apiKey = try container.decodeIfPresent(String.self, forKey: .apiKey)
        chainId = try container.decodeIfPresent(Int.self, forKey: .chainId)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        userId = try container.decodeIfPresent(Int.self, forKey: .userId)
        fullDetail = try container.decodeIfPresent(Bool.self, forKey: .fullDetail)
        restrictedId = try container.decodeIfPresent(Int.self, forKey: .restrictedId)
        restrictedResourceType = try container.decodeIfPresent(RestrictedResourceType.self, forKey: .restrictedResourceType)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if apiKey != nil { try container.encode(apiKey, forKey: .apiKey) }
        if chainId != nil { try container.encode(chainId, forKey: .chainId) }
        if storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if userId != nil { try container.encode(userId, forKey: .userId) }
        if fullDetail != nil { try container.encode(fullDetail, forKey: .fullDetail) }
        if restrictedId != nil { try container.encode(restrictedId, forKey: .restrictedId) }
        if restrictedResourceType != nil { try container.encode(restrictedResourceType, forKey: .restrictedResourceType) }
    }
}

public class ApiDtoBase : Codable
{
    public var apiKey:String
    public var storeId:Int?
    public var chainId:Int?

    required public init(){}
}

public enum RestrictedResourceType : String, Codable
{
    case Store
    case Chain
    case User
    case Undefined
}

public class CreditDetailResponse : CreditDetailResponseDto
{
    public var success:Bool
    public var message:String
    public var totalPurchased:Int?
    public var totalAvailable:Int?
    public var credits:[SessionCreditDetail] = []

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

    private enum CodingKeys : String, CodingKey {
        case success
        case message
        case totalPurchased
        case totalAvailable
        case credits
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        success = try container.decodeIfPresent(Bool.self, forKey: .success)
        message = try container.decodeIfPresent(String.self, forKey: .message)
        totalPurchased = try container.decodeIfPresent(Int.self, forKey: .totalPurchased)
        totalAvailable = try container.decodeIfPresent(Int.self, forKey: .totalAvailable)
        credits = try container.decodeIfPresent([SessionCreditDetail].self, forKey: .credits) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if success != nil { try container.encode(success, forKey: .success) }
        if message != nil { try container.encode(message, forKey: .message) }
        if totalPurchased != nil { try container.encode(totalPurchased, forKey: .totalPurchased) }
        if totalAvailable != nil { try container.encode(totalAvailable, forKey: .totalAvailable) }
        if credits.count > 0 { try container.encode(credits, forKey: .credits) }
    }
}

public class CreditDetailResponseDto : ApiResponseBase
{
    public var totalPurchased:Int?
    public var totalAvailable:Int?
    public var credits:[SessionCreditDetail] = []

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

    private enum CodingKeys : String, CodingKey {
        case totalPurchased
        case totalAvailable
        case credits
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        totalPurchased = try container.decodeIfPresent(Int.self, forKey: .totalPurchased)
        totalAvailable = try container.decodeIfPresent(Int.self, forKey: .totalAvailable)
        credits = try container.decodeIfPresent([SessionCreditDetail].self, forKey: .credits) ?? []
    }

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

public class ApiResponseBase : Codable
{
    public var success:Bool
    public var message:String

    required public init(){}
}

public class SessionCreditDetail : Codable
{
    public var serviceId:Int?
    public var sessionSizeId:Int?
    public var classId:Int?
    public var name:String
    public var total:Int
    public var available:Int
    public var storeId:Int?

    required public init(){}
}

Swift CreditDetailRequest DTOs

GET /scheduling/{UserId}/credit-detail HTTP/1.1 
Host: clubready.com 
Accept: application/json

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

{"Success":false,"Message":"String","TotalPurchased":0,"TotalAvailable":0,"Credits":[{"ServiceId":0,"SessionSizeId":0,"ClassId":0,"Name":"String","Total":0,"Available":0,"StoreId":0}]}