/* Options:
Date: 2024-11-24 13:22:28
SwiftVersion: 5.0
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://clubready.com/api/current

//BaseClass: 
//AddModelExtensions: True
//AddServiceStackTypes: True
IncludeTypes: PaymentProfileBalanceInquiryEndpoint.*
//ExcludeTypes: 
//ExcludeGenericBaseTypes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: Foundation,ServiceStack
*/

import Foundation
import ServiceStack

// @Route("/sales/paymentProfile/balanceInquiry", "GET")
// @ApiResponse(Description="Looks up the balance of a payment profile created by the Vault API", ResponseType=typeof(PaymentProfileBalanceInquiryResponse), StatusCode=200)
public class PaymentProfileBalanceInquiryEndpoint : PaymentProfileBalanceInquiryRequest, IReturn, IApiKeyEndpoint
{
    public typealias Return = PamentProfileBalanceInquiryEndpointResponse

    /**
    * Api Authentication Key
    */
    // @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    public var apiKey:String

    /**
    * Store Id
    */
    // @ApiMember(Description="Store Id", IsRequired=true, ParameterType="query")
    public var storeId:Int

    /**
    * Encoded data uniquely identifying the payment profile.  Long term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater).  The length is usually 80 characters.
    */
    // @ApiMember(Description="\r\nEncoded data uniquely identifying the payment profile.  \r\nLong term storage of AcctToken is not recommended, as the token may change over time (for example, by processes like Account Updater).  \r\nThe length is usually 80 characters.", IsRequired=true)
    public var acctToken:String

    /**
    * Encoded data containing non-PCI information about the Payment Profile.  ProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes,it cannot be accepted and a new profile will have to be created with a new AcctToken. The timevalidation is to prevent old tokens from be re-played at a later time.  The length is variable, but generally around 1,000 characters.
    */
    // @ApiMember(Description="\r\nEncoded data containing non-PCI information about the Payment Profile.  \r\n\r\nProfileTokens contain a timestamp. If the ClubReady API does not process the token within 5 minutes,\r\nit cannot be accepted and a new profile will have to be created with a new AcctToken. The time\r\nvalidation is to prevent old tokens from be re-played at a later time.  \r\n\r\nThe length is variable, but generally around 1,000 characters.")
    public var profileToken:String

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

    private enum CodingKeys : String, CodingKey {
        case apiKey
        case storeId
        case acctToken
        case profileToken
    }

    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)
        storeId = try container.decodeIfPresent(Int.self, forKey: .storeId)
        acctToken = try container.decodeIfPresent(String.self, forKey: .acctToken)
        profileToken = try container.decodeIfPresent(String.self, forKey: .profileToken)
    }

    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 storeId != nil { try container.encode(storeId, forKey: .storeId) }
        if acctToken != nil { try container.encode(acctToken, forKey: .acctToken) }
        if profileToken != nil { try container.encode(profileToken, forKey: .profileToken) }
    }
}

public class PamentProfileBalanceInquiryEndpointResponse : Codable
{
    public var success:Bool
    public var last4:String
    public var accountBalance:Double?
    public var responseCode:String
    public var message:String

    required public init(){}
}

public protocol IApiKeyEndpoint
{
    var apiKey:String { get set }

}

public class PaymentProfileBalanceInquiryRequest : Codable
{
    public var terminalIpAddress:String
    public var acctToken:String
    public var profileToken:String
    public var storeId:Int

    required public init(){}
}