/* Options:
Date: 2025-07-19 18:54:34
SwiftVersion: 5.0
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://www.clubready.com/api/current

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

import Foundation
import ServiceStack

// @Route("/sales/agreement/add", "POST")
// @ApiResponse(Description="", ResponseType=typeof(AddResponse), StatusCode=200)
public class AgreementAddEndpoint : IReturn, IAddEndpoint, IRestrictedApiRequest, Codable
{
    public typealias Return = AddResponse

    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
    public var xForwardedFor:String

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

    /**
    * Member Id of the user buying the Package
    */
    // @ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
    public var memberId:Int

    public var chainId:Int?
    /**
    * Id of the store for the user
    */
    // @ApiMember(Description="Id of the store for the user", IsRequired=true)
    public var storeId:Int?

    /**
    * Package Id number of the package being purchased
    */
    // @ApiMember(Description="Package Id number of the package being purchased", IsRequired=true)
    public var packageId:Int

    /**
    * Installment Plan Id being purchased. If empty, the default package will be selected.
    */
    // @ApiMember(Description="Installment Plan Id being purchased. If empty, the default package will be selected.")
    public var installmentId:Int?

    /**
    * Date contract takes affect
    */
    // @ApiMember(Description="Date contract takes affect")
    public var startDate:Date?

    /**
    * Promo code to apply a discount.
    */
    // @ApiMember(Description="Promo code to apply a discount.")
    public var promoCode:String

    /**
    * Staff Id of salesperson who sold the agreement.
    */
    // @ApiMember(Description="Staff Id of salesperson who sold the agreement.")
    public var staffId:Int?

    public var restrictedId:Int?
    public var restrictedResourceType:RestrictedResourceType

    required public init(){}
}

public class AddResponse : ApiResponse2Base
{
    public var incompleteAgreementToken:String
    public var contractId:Int?

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

    private enum CodingKeys : String, CodingKey {
        case incompleteAgreementToken
        case contractId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        incompleteAgreementToken = try container.decodeIfPresent(String.self, forKey: .incompleteAgreementToken)
        contractId = try container.decodeIfPresent(Int.self, forKey: .contractId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if incompleteAgreementToken != nil { try container.encode(incompleteAgreementToken, forKey: .incompleteAgreementToken) }
        if contractId != nil { try container.encode(contractId, forKey: .contractId) }
    }
}

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

public protocol IApiDtoBase
{
    var apiKey:String { get set }
    var storeId:Int? { get set }
    var chainId:Int? { get set }

}

public protocol IRestrictedApiRequest : IApiKeyEndpoint
{
    var restrictedId:Int? { get set }
    var restrictedResourceType:RestrictedResourceType { get set }

}

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

}

public protocol IAddEndpoint : IApiDtoBase
{
    var memberId:Int { get set }
    var packageId:Int { get set }
    var installmentId:Int? { get set }
    var startDate:Date? { get set }
    var promoCode:String { get set }
    var staffId:Int? { get set }

}

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

    required public init(){}
}