/* Options:
Date: 2024-11-24 14:36:46
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://clubready.com/api/current

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: SellContractRequest.*
//ExcludeTypes: 
//InitializeCollections: True
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

import java.math.*
import java.util.*
import net.servicestack.client.*


@Route(Path="/sales/contract/sold", Verbs="POST")
@ApiResponse(Description="", ResponseType=SellContractResultDto.class, StatusCode=200)
open class SellContractRequest : SellContractRequestDto(), IReturn<SellContractResultDto>, IRestrictedApiRequest
{
    /**
    * Api Authentication Key
    */
    @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
    var ApiKey:String? = null

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

    /**
    * Id for the chain of the Api Key
    */
    @ApiMember(Description="Id for the chain of the Api Key")
    var ChainId:Int? = null

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

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

    /**
    * 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.")
    var InstallmentId:Int? = null

    /**
    * Amount being paid down, including tax
    */
    @ApiMember(Description="Amount being paid down, including tax", IsRequired=true)
    var PaymentAmount:BigDecimal? = null

    /**
    * Promo code to apply a discount.
    */
    @ApiMember(Description="Promo code to apply a discount.")
    var PromoCode:String? = null

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

    /**
    * An array of Payment Methods to be used for this purchase. Any entry with PreferredOnFile is assumed if omitted or null.  Each object of the array may contain properties:| Property | Description || --- | --- || PaymentMethodType | Usually "AcctToken" (Default or omitted/null) or "PreferredOnFile" || PaymentAmount | The amount to be attempted for this Payment Method. When omitted (or null), the Request's PaymentAmount will be attempted || AcctToken | The AcctToken to attempt payment (when using PaymentMethodType:AcctToken) || ProfileToken | When provided (with AcctToken), a Payment Profile will be created (this will prevent the requirement to call `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) || DoNotUpdatePaymentTypePreference | When using ProfileToken, do not set the PaymentTypePreference (for more information, see `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) || | |* Scenario #1: Use the on file profile only. PaymentMethods can be omitted/null, or :  JSON:```json{    PaymentMethods: [        {            "PaymentMethodType":"PreferredOnFile",            "PaymentAmount":"1.00"        }    ]}```JSV:```jsv[{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]```* Scenario #2: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card.  JSON:```json{    PaymentMethods: [        {            "PaymentMethodType":"AcctToken",            "PaymentAmount":"1.00",            "AcctToken":"eyJ...GiftCard AcctToken...",            "ProfileToken":"eyJ...Gift Card ProfileToken..."        },        {            "PaymentMethodType":"PreferredOnFile",            "PaymentAmount":"1.00"        }    ]}```JSV:```jsv[{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]```  Notes:  * The example shows PaymentAmount of 1.00 for both "AcctToken" and "PreferredOnFile". This is for the examplewith a total of $1.00. The firstPaymentMethod (the Gift Card) will be attempted for $1.00. If it partially approvesfor less than 1.00 (example: $0.80), the second payment method (PreferredOnFile) will be attempted for the lesser ofit's PaymentAmount and the remaining amount (example: $0.20).* If ProfileToken has already been used (e.g. used with `/sales/paymentprofile/import`), it does not need to be included,but AcctToken is required. ProfileToken is only needed once to 'activate' the AcctToken.* When using Query String (or this web site), this value must be encoded with JSV [(JSON-like Separated Values)](https://docs.servicestack.net/jsv-format).Basic steps to convert JSON to JSV: 1) Remove properties that are null, 2) Remove white space including line feeds, 3) Remove quotes.
    */
    @ApiMember(Description="\r\nAn array of Payment Methods to be used for this purchase. Any entry with PreferredOnFile is assumed if omitted or null.  \r\n\r\nEach object of the array may contain properties:\r\n\r\n| Property | Description |\r\n| --- | --- |\r\n| PaymentMethodType | Usually \"AcctToken\" (Default or omitted/null) or \"PreferredOnFile\" |\r\n| PaymentAmount | The amount to be attempted for this Payment Method. When omitted (or null), the Request's PaymentAmount will be attempted |\r\n| AcctToken | The AcctToken to attempt payment (when using PaymentMethodType:AcctToken) |\r\n| ProfileToken | When provided (with AcctToken), a Payment Profile will be created (this will prevent the requirement to call `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) |\r\n| DoNotUpdatePaymentTypePreference | When using ProfileToken, do not set the PaymentTypePreference (for more information, see `/sales/paymentprofile/import` (when using PaymentMethodType:AcctToken) |\r\n| | |\r\n\r\n* Scenario #1: Use the on file profile only. PaymentMethods can be omitted/null, or :  \r\n\r\nJSON:\r\n```json\r\n{\r\n    PaymentMethods: [\r\n        {\r\n            \"PaymentMethodType\":\"PreferredOnFile\",\r\n            \"PaymentAmount\":\"1.00\"\r\n        }\r\n    ]\r\n}\r\n```\r\nJSV:\r\n```jsv\r\n[{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]\r\n```\r\n\r\n\r\n* Scenario #2: Use a Gift Card with PreferredOnFile to cover the amount not approved by the Gift Card.  \r\n\r\nJSON:\r\n```json\r\n{\r\n    PaymentMethods: [\r\n        {\r\n            \"PaymentMethodType\":\"AcctToken\",\r\n            \"PaymentAmount\":\"1.00\",\r\n            \"AcctToken\":\"eyJ...GiftCard AcctToken...\",\r\n            \"ProfileToken\":\"eyJ...Gift Card ProfileToken...\"\r\n        },\r\n        {\r\n            \"PaymentMethodType\":\"PreferredOnFile\",\r\n            \"PaymentAmount\":\"1.00\"\r\n        }\r\n    ]\r\n}\r\n```\r\nJSV:\r\n```jsv\r\n[{PaymentMethodType:AcctToken,PaymentAmount:1.00,AcctToken:eyj...,ProfileToken:eyJ...},{PaymentMethodType:PreferredOnFile,PaymentAmount:1.00}]\r\n```  \r\n\r\nNotes:  \r\n\r\n* The example shows PaymentAmount of 1.00 for both \"AcctToken\" and \"PreferredOnFile\". This is for the example\r\nwith a total of $1.00. The firstPaymentMethod (the Gift Card) will be attempted for $1.00. If it partially approves\r\nfor less than 1.00 (example: $0.80), the second payment method (PreferredOnFile) will be attempted for the lesser of\r\nit's PaymentAmount and the remaining amount (example: $0.20).\r\n\r\n* If ProfileToken has already been used (e.g. used with `/sales/paymentprofile/import`), it does not need to be included,\r\nbut AcctToken is required. ProfileToken is only needed once to 'activate' the AcctToken.\r\n\r\n* When using Query String (or this web site), this value must be encoded with JSV [(JSON-like Separated Values)](https://docs.servicestack.net/jsv-format).\r\nBasic steps to convert JSON to JSV: 1) Remove properties that are null, 2) Remove white space including line feeds, 3) Remove quotes.\r\n")
    var PaymentMethods:ArrayList<PaymentMethodDto> = ArrayList<PaymentMethodDto>()

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
    companion object { private val responseType = SellContractResultDto::class.java }
    override fun getResponseType(): Any? = SellContractRequest.responseType
}

open class SellContractResultDto
{
    var ContractSaleID:String? = null
    var description:String? = null
    var Success:Boolean? = null
    var PaymentResponses:IReadOnlyList<PendingPaymentResponse>? = null
}

enum class RestrictedResourceType
{
    Store,
    Chain,
    User,
    Undefined,
}

open interface IRestrictedApiRequest : IApiKeyEndpoint
{
    var RestrictedId:Int?
    var RestrictedResourceType:RestrictedResourceType?
}

open interface IApiKeyEndpoint
{
    var ApiKey:String?
}

open class ApiDtoBase
{
    var ApiKey:String? = null
    var StoreId:Int? = null
    var ChainId:Int? = null
}

@DataContract
open class PaymentMethodDto
{
    @DataMember
    var AcctToken:String? = null

    @DataMember
    var ProfileToken:String? = null

    @DataMember
    var PaymentProfileId:String? = null

    @DataMember
    var PaymentAmount:BigDecimal? = null

    @DataMember
    var PaymentMethodType:PaymentMethodType? = null

    @DataMember
    var DoNotUpdatePaymentTypePreference:Boolean? = null
}

open class SellContractRequestDto : ApiDtoBase()
{
    var MemberId:Int? = null
    var PackageId:Int? = null
    var InstallmentId:Int? = null
    var StartDate:Date? = null
    var PaymentAmount:BigDecimal? = null
    var PromoCode:String? = null
    var PaymentMethods:ArrayList<PaymentMethodDto> = ArrayList<PaymentMethodDto>()
    var StaffId:Int? = null
}

open class PendingPaymentResponse
{
    var ResponseTransactionId:String? = null
    var ResponseTxnId:String? = null
    var ResponseStatus:ResponseStatus? = null
    var ResponseAmount:BigDecimal? = null
    var ResponseText:String? = null
    var Last4:String? = null
    var AcctClass:String? = null
    var AcctType:String? = null
    var AcctToken:String? = null
}

enum class PaymentMethodType(val value:Int)
{
    Uninitialized(0),
    PaymentProfileId(1),
    PreferredOnFile(2),
    AcctToken(3),
    Error(-1),
}