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

//GlobalNamespace: 
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: SaleEndpoint.*
//ExcludeTypes: 
//DefaultImports: package:servicestack/servicestack.dart
*/

import 'package:servicestack/servicestack.dart';

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

abstract class IApiDtoBase
{
    String? ApiKey;
    int? StoreId;
    int? ChainId;
}

abstract class IRestrictedApiRequest extends IApiKeyEndpoint
{
    int? RestrictedId;
    RestrictedResourceType? RestrictedResourceType;
}

abstract class IApiKeyEndpoint
{
    String? ApiKey;
}

// @DataContract
class PaymentMethodDto implements IConvertible
{
    // @DataMember
    String? AcctToken;

    // @DataMember
    String? ProfileToken;

    // @DataMember
    String? PaymentProfileId;

    // @DataMember
    double? PaymentAmount;

    // @DataMember
    bool? UsePreferred;

    // @DataMember
    bool? DoNotUpdatePaymentTypePreference;

    PaymentMethodDto({this.AcctToken,this.ProfileToken,this.PaymentProfileId,this.PaymentAmount,this.UsePreferred,this.DoNotUpdatePaymentTypePreference});
    PaymentMethodDto.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AcctToken = json['AcctToken'];
        ProfileToken = json['ProfileToken'];
        PaymentProfileId = json['PaymentProfileId'];
        PaymentAmount = JsonConverters.toDouble(json['PaymentAmount']);
        UsePreferred = json['UsePreferred'];
        DoNotUpdatePaymentTypePreference = json['DoNotUpdatePaymentTypePreference'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AcctToken': AcctToken,
        'ProfileToken': ProfileToken,
        'PaymentProfileId': PaymentProfileId,
        'PaymentAmount': PaymentAmount,
        'UsePreferred': UsePreferred,
        'DoNotUpdatePaymentTypePreference': DoNotUpdatePaymentTypePreference
    };

    getTypeName() => "PaymentMethodDto";
    TypeContext? context = _ctx;
}

abstract class IAgreementSaleEndpoint extends IApiDtoBase
{
    int? MemberId;
    double? PaymentAmount;
    List<PaymentMethodDto>? PaymentMethods;
    String? IncompleteAgreementToken;
}

class ApiResponse2Base implements IConvertible
{
    bool? success;
    String? message;

    ApiResponse2Base({this.success,this.message});
    ApiResponse2Base.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        success = json['success'];
        message = json['message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'success': success,
        'message': message
    };

    getTypeName() => "ApiResponse2Base";
    TypeContext? context = _ctx;
}

class SaleResponse extends ApiResponse2Base implements IConvertible
{
    SaleResponse();
    SaleResponse.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "SaleResponse";
    TypeContext? context = _ctx;
}

// @Route("/sales/agreement/sale", "POST")
// @ApiResponse(Description="", ResponseType=typeof(SaleResponse), StatusCode=200)
class SaleEndpoint implements IReturn<SaleResponse>, IAgreementSaleEndpoint, IRestrictedApiRequest, IConvertible
{
    /**
    * IP address of the end user
    */
    // @ApiMember(Description="IP address of the end user", IsRequired=true, Name="X-Forwarded-For", ParameterType="header")
    String? XForwardedFor;

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

    /**
    * Member Id of the user buying the Package
    */
    // @ApiMember(Description="Member Id of the user buying the Package", IsRequired=true, ParameterType="query")
    int? MemberId;

    int? ChainId;
    /**
    * Id of the store for the user
    */
    // @ApiMember(Description="Id of the store for the user", IsRequired=true)
    int? StoreId;

    /**
    * IncompleteAgreementToken from Agreement/ContractText endpoint.
    */
    // @ApiMember(Description="IncompleteAgreementToken from Agreement/ContractText endpoint.", IsRequired=true)
    String? IncompleteAgreementToken;

    /**
    * Amount being paid down, including tax
    */
    // @ApiMember(Description="Amount being paid down, including tax", IsRequired=true)
    double? PaymentAmount;

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

    /**
    * Staff Id of salesperson who sold the agreement.
    */
    // @ApiMember(Description="Staff Id of salesperson who sold the agreement.")
    int? StaffId;

    /**
    * 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}]`).")
    List<PaymentMethodDto>? PaymentMethods;

    int? RestrictedId;
    RestrictedResourceType? RestrictedResourceType;

    SaleEndpoint({this.XForwardedFor,this.ApiKey,this.MemberId,this.ChainId,this.StoreId,this.IncompleteAgreementToken,this.PaymentAmount,this.PromoCode,this.StaffId,this.PaymentMethods,this.RestrictedId,this.RestrictedResourceType});
    SaleEndpoint.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        XForwardedFor = json['XForwardedFor'];
        ApiKey = json['ApiKey'];
        MemberId = json['MemberId'];
        ChainId = json['ChainId'];
        StoreId = json['StoreId'];
        IncompleteAgreementToken = json['IncompleteAgreementToken'];
        PaymentAmount = JsonConverters.toDouble(json['PaymentAmount']);
        PromoCode = json['PromoCode'];
        StaffId = json['StaffId'];
        PaymentMethods = JsonConverters.fromJson(json['PaymentMethods'],'List<PaymentMethodDto>',context!);
        RestrictedId = json['RestrictedId'];
        RestrictedResourceType = JsonConverters.fromJson(json['RestrictedResourceType'],'RestrictedResourceType',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'XForwardedFor': XForwardedFor,
        'ApiKey': ApiKey,
        'MemberId': MemberId,
        'ChainId': ChainId,
        'StoreId': StoreId,
        'IncompleteAgreementToken': IncompleteAgreementToken,
        'PaymentAmount': PaymentAmount,
        'PromoCode': PromoCode,
        'StaffId': StaffId,
        'PaymentMethods': JsonConverters.toJson(PaymentMethods,'List<PaymentMethodDto>',context!),
        'RestrictedId': RestrictedId,
        'RestrictedResourceType': JsonConverters.toJson(RestrictedResourceType,'RestrictedResourceType',context!)
    };

    createResponse() => SaleResponse();
    getResponseTypeName() => "SaleResponse";
    getTypeName() => "SaleEndpoint";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'www.clubready.com', types: <String, TypeInfo> {
    'RestrictedResourceType': TypeInfo(TypeOf.Enum, enumValues:RestrictedResourceType.values),
    'IApiDtoBase': TypeInfo(TypeOf.Interface),
    'IRestrictedApiRequest': TypeInfo(TypeOf.Interface),
    'IApiKeyEndpoint': TypeInfo(TypeOf.Interface),
    'PaymentMethodDto': TypeInfo(TypeOf.Class, create:() => PaymentMethodDto()),
    'IAgreementSaleEndpoint': TypeInfo(TypeOf.Interface),
    'ApiResponse2Base': TypeInfo(TypeOf.Class, create:() => ApiResponse2Base()),
    'SaleResponse': TypeInfo(TypeOf.Class, create:() => SaleResponse()),
    'SaleEndpoint': TypeInfo(TypeOf.Class, create:() => SaleEndpoint()),
    'List<PaymentMethodDto>': TypeInfo(TypeOf.Class, create:() => <PaymentMethodDto>[]),
});