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

//Package: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: ContractSoldNewUserEndpoint.*
//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/new/user", Verbs="POST")
@ApiResponse(Description="", ResponseType=ContractSoldNewUserResponse.class, StatusCode=200)
open class ContractSoldNewUserEndpoint : IContractSoldNewUserEndpoint, IRestrictedApiRequest
{
    /**
    * IP address of the end user
    */
    @ApiMember(Description="IP address of the end user", Name="X-Forwarded-For", ParameterType="header")
    var XForwardedFor:String? = null

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

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

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

    /**
    * Package Id being sold
    */
    @ApiMember(Description="Package Id being sold", IsRequired=true)
    var PackageId:Int? = null

    /**
    * Installment Plan Id being sold
    */
    @ApiMember(Description="Installment Plan Id being sold", IsRequired=true)
    var InstallmentPlanId:Int? = null

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

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

    /**
    * First Name
    */
    @ApiMember(Description="First Name", IsRequired=true)
    var FirstName:String? = null

    /**
    * Last Name
    */
    @ApiMember(Description="Last Name", IsRequired=true)
    var LastName:String? = null

    /**
    * Email Address
    */
    @ApiMember(Description="Email Address", IsRequired=true)
    var Email:String? = null

    /**
    * Gender
    */
    @ApiMember(Description="Gender")
    var Gender:String? = null

    /**
    * Address
    */
    @ApiMember(Description="Address")
    var Address:String? = null

    /**
    * City
    */
    @ApiMember(Description="City")
    var City:String? = null

    /**
    * State
    */
    @ApiMember(Description="State")
    var State:String? = null

    /**
    * Zip Code
    */
    @ApiMember(Description="Zip Code")
    var Zip:String? = null

    /**
    * Home phone
    */
    @ApiMember(Description="Home phone")
    var Phone:String? = null

    /**
    * Work phone
    */
    @ApiMember(Description="Work phone")
    var WorkPhone:String? = null

    /**
    * Date of Birth
    */
    @ApiMember(Description="Date of Birth")
    var DateOfBirth:Date? = null

    /**
    * Cell phone
    */
    @ApiMember(Description="Cell phone")
    var CellPhone:String? = null

    /**
    * Add an internal note for the new prospect
    */
    @ApiMember(Description="Add an internal note for the new prospect")
    var Note:String? = null

    /**
    * Unique Id for the user from your system. We store internally as ExternalUserId
    */
    @ApiMember(Description="Unique Id for the user from your system. We store internally as ExternalUserId")
    var ExternalId:String? = null

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

    /**
    * Username should be between 4 and 255 characters long
    */
    @ApiMember(Description="Username should be between 4 and 255 characters long")
    var Username:String? = null

    /**
    * ReferralTypeId
    */
    @ApiMember(Description="ReferralTypeId")
    var ReferralTypeId:Int? = null

    /**
    * Emergency contact name
    */
    @ApiMember(Description="Emergency contact name")
    var EmergencyContactName:String? = null

    /**
    * Emergency contact phone number
    */
    @ApiMember(Description="Emergency contact phone number")
    var EmergencyContactPhone:String? = null

    /**
    * Emergency contact relationship
    */
    @ApiMember(Description="Emergency contact relationship")
    var EmergencyContactType:String? = null

    /**
    * An array of PaymentMethod objects to be used for this purchase. A null array (or omitted property) will use thePreferred method for the total amount.Each object of the array may contain properties:| Property | Description || --- | --- || PaymentAmount | The maximum amount to be attempted for this PaymentMethod. When null or omitted, the remaining PaymentAmount will be attempted. || **Use only one of the following three** | **UsePreferred** or **AcctToken** or **ProfileToken [DoNotUpdatePaymentTypePreference]** || UsePreferred | Set to `true` to use the Preferred method, otherwise omit the value or set to `null` or `false` || AcctToken | The AcctToken to attempt payment || ProfileToken | When provided, a PaymentMethod will be created (this will prevent the requirement to call `/sales/paymentprofile/import`) || DoNotUpdatePaymentTypePreference | [Optional] When creating a PaymentMethod (ProfileToken), it is set as the preferred method. To not create as preferred, set `DoNotUpdatePaymentTypePreference` to `true`. (for more information, see `/sales/paymentprofile/import`) || | |Only one of `UsePreferred`, `AcctToken`, `ProfileToken` or is needed. `DoNotUpdatePaymentTypePreference` is optionaland only valid with `ProfileToken`.* Scenario #1: Sell $3 contract using an existing PaymentMethod (i.e. AcctToken) for $1 and the Preferred method for $2.JSON:```json{    ...    "PaymentAmount": 3.00,    "PaymentMethods": [        {            "PaymentAmount": "1.00",            "AcctToken": "eyJ..."        },        {            "PaymentAmount": "2.00",            "UsePreferred": true        }    ]}```JSV:```...,PaymentAmount:3.00,PaymentMethods:[{PaymentAmount:1.00,AcctToken:eyJ...NdQ},{PaymentAmount:2.00,UsePreferred:true}]```* Scenario #2: Sell $3 contract using a new PaymentMethod (i.e. ProfileToken) for $1 and the Preferred method for the remaining.Note, the sum of the PaymentMethod's PaymentAmount ($4) is greater than the agreement amount ($3). PaymentAmount is the maximum amount.This allows the first PaymentMethod to decline or partially approve (common with gift cards). Therefore, if the first PaymentMethod approvesfor $0.75, the second will be attempted for $2.25.JSON:```json{     ...    "PaymentAmount": 3.00,    "PaymentMethods": [        {            "PaymentAmount": "1.00",            "ProfileToken": "eyJ..."        },        {            "PaymentAmount": "3.00",            "UsePreferred": true        }    ]}```JSV:```jsv...,PaymentAmount:3.00,PaymentMethods:[{PaymentAmount:1.00,ProfileToken:eyj...NdQ},{PaymentAmount:3.00,UsePreferred:true}]```Notes:  * AcctTokens should not be parsed or persisted in the client application. They are currently jsonbased, but can be updated without notice.* ProfileToken is used to create a PaymentMethod in the ClubReady system. For more information, see `/sales/paymentprofile/import`.* If `PaymentMethods` is missing or `null`, the Preferred method will be used.* If a `PaymentMethods` `PaymentAmount` is not specified, the remaining amount will be attempted.* If a PaymentMethod is partially approved (common for gift cards), the PaymentMethod with anunspecified PaymentAmount will be charged the remaining amount, including the unapproved amount not.* When testing with this website, the PaymentMethods textbox needs JSV and only the square brackets and contents(e.g. `[{PaymentAmount:1.00,UsePreferred:true}]`).
    */
    @ApiMember(Description="An array of PaymentMethod objects to be used for this purchase. A null array (or omitted property) will use the\r\nPreferred method for the total amount.\r\n\r\nEach object of the array may contain properties:\r\n\r\n| Property | Description |\r\n| --- | --- |\r\n| PaymentAmount | The maximum amount to be attempted for this PaymentMethod. When null or omitted, the remaining PaymentAmount will be attempted. |\r\n| **Use only one of the following three** | **UsePreferred** or **AcctToken** or **ProfileToken [DoNotUpdatePaymentTypePreference]** |\r\n| UsePreferred | Set to `true` to use the Preferred method, otherwise omit the value or set to `null` or `false` |\r\n| AcctToken | The AcctToken to attempt payment |\r\n| ProfileToken | When provided, a PaymentMethod will be created (this will prevent the requirement to call `/sales/paymentprofile/import`) |\r\n| DoNotUpdatePaymentTypePreference | [Optional] When creating a PaymentMethod (ProfileToken), it is set as the preferred method. To not create as preferred, set `DoNotUpdatePaymentTypePreference` to `true`. (for more information, see `/sales/paymentprofile/import`) |\r\n| | |\r\n\r\nOnly one of `UsePreferred`, `AcctToken`, `ProfileToken` or is needed. `DoNotUpdatePaymentTypePreference` is optional\r\nand only valid with `ProfileToken`.\r\n\r\n* Scenario #1: Sell $3 contract using an existing PaymentMethod (i.e. AcctToken) for $1 and the Preferred method for $2.\r\n\r\nJSON:\r\n```json\r\n{\r\n    ...\r\n    \"PaymentAmount\": 3.00,\r\n    \"PaymentMethods\": [\r\n        {\r\n            \"PaymentAmount\": \"1.00\",\r\n            \"AcctToken\": \"eyJ...\"\r\n        },\r\n        {\r\n            \"PaymentAmount\": \"2.00\",\r\n            \"UsePreferred\": true\r\n        }\r\n    ]\r\n}\r\n```\r\nJSV:\r\n```\r\n...,PaymentAmount:3.00,PaymentMethods:[{PaymentAmount:1.00,AcctToken:eyJ...NdQ},{PaymentAmount:2.00,UsePreferred:true}]\r\n```\r\n\r\n* Scenario #2: Sell $3 contract using a new PaymentMethod (i.e. ProfileToken) for $1 and the Preferred method for the remaining.\r\nNote, the sum of the PaymentMethod's PaymentAmount ($4) is greater than the agreement amount ($3). PaymentAmount is the maximum amount.\r\nThis allows the first PaymentMethod to decline or partially approve (common with gift cards). Therefore, if the first PaymentMethod approves\r\nfor $0.75, the second will be attempted for $2.25.\r\n\r\nJSON:\r\n```json\r\n{ \r\n    ...\r\n    \"PaymentAmount\": 3.00,\r\n    \"PaymentMethods\": [\r\n        {\r\n            \"PaymentAmount\": \"1.00\",\r\n            \"ProfileToken\": \"eyJ...\"\r\n        },\r\n        {\r\n            \"PaymentAmount\": \"3.00\",\r\n            \"UsePreferred\": true\r\n        }\r\n    ]\r\n}\r\n```\r\nJSV:\r\n```jsv\r\n...,PaymentAmount:3.00,PaymentMethods:[{PaymentAmount:1.00,ProfileToken:eyj...NdQ},{PaymentAmount:3.00,UsePreferred:true}]\r\n```\r\n\r\nNotes:  \r\n\r\n* AcctTokens should not be parsed or persisted in the client application. They are currently json\r\nbased, but can be updated without notice.\r\n\r\n* ProfileToken is used to create a PaymentMethod in the ClubReady system. For more information, \r\nsee `/sales/paymentprofile/import`.\r\n\r\n* If `PaymentMethods` is missing or `null`, the Preferred method will be used.\r\n\r\n* If a `PaymentMethods` `PaymentAmount` is not specified, the remaining amount will be attempted.\r\n\r\n* If a PaymentMethod is partially approved (common for gift cards), the PaymentMethod with an\r\nunspecified PaymentAmount will be charged the remaining amount, including the unapproved amount not.\r\n\r\n* When testing with this website, the PaymentMethods textbox needs JSV and only the square brackets and contents\r\n(e.g. `[{PaymentAmount:1.00,UsePreferred:true}]`).")
    var PaymentMethods:ArrayList<PaymentMethodDto> = ArrayList<PaymentMethodDto>()

    var RestrictedId:Int? = null
    var RestrictedResourceType:RestrictedResourceType? = null
}

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

open interface IApiDtoBase
{
    var ApiKey:String?
    var StoreId:Int?
    var ChainId:Int?
}

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

open interface IApiKeyEndpoint
{
    var ApiKey:String?
}

@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 UsePreferred:Boolean? = null

    @DataMember
    var DoNotUpdatePaymentTypePreference:Boolean? = null
}

@DataContract
enum class AcctType(val value:Int)
{
    Uninitialized(0),
    Visa(1),
    Mc(2),
    Disc(3),
    Amex(4),
    Diners(5),
    Jcb(6),
    EnRoute(7),
    PayPal(8),
    BillMe(9),
    Pc(11),
    Ps(12),
    Bc(13),
    Bs(14),
    Becs(15),
    Bacs(16),
    Maestro(20),
    Solo(21),
    VisaElectron(22),
    Cibc(23),
    RoyalBankCa(24),
    TdCaTrust(25),
    Scotia(26),
    Bmo(27),
    HsbcCa(28),
    UnionPay(29),
    InterPayment(30),
    Laser(31),
    UnknownCredit(40),
    TransArmor(41),
    Factor4(42),
    XPass(43),
    ConnectedAccount(44),
    UnknownBank(45),
    Error(-1),
}

open interface IContractSoldNewUserEndpoint : IApiDtoBase
{
    var AcctToken:String?
    var Last4:String?
    var ExpMonth:Int?
    var ExpYear:Int?
    var AcctType:AcctType?
    var BnkRoute:Int?
    var IsTemp:Boolean?
    var PackageId:Int?
    var InstallmentPlanId:Int?
    var PaymentAmount:BigDecimal?
    var StartDate:Date?
    var FirstName:String?
    var LastName:String?
    var Address:String?
    var City:String?
    var State:String?
    var Zip:String?
    var Email:String?
    var Gender:String?
    var Phone:String?
    var WorkPhone:String?
    var DateOfBirth:Date?
    var CellPhone:String?
    var Note:String?
    var ExternalId:String?
    var PromoCode:String?
    var Username:String?
    var ReferralTypeId:Int?
    var EmergencyContactName:String?
    var EmergencyContactPhone:String?
    var EmergencyContactType:String?
    var PaymentMethods:ArrayList<PaymentMethodDto>?
}