/* Options:
Date: 2024-05-11 16:55:10
Version: 6.50
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://www.clubready.com/api/current

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: PaymentProfileImportEndpoint.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

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

public class dtos
{

    @Route(Path="/sales/paymentprofile/import", Verbs="POST")
    @ApiResponse(Description="", ResponseType=PaymentProfileImportResponse.class, StatusCode=200)
    public static class PaymentProfileImportEndpoint extends PaymentProfileImportRequest implements IReturn<PaymentProfileImportResponse>, IApiKeyEndpoint
    {
        /**
        * Api Authentication Key
        */
        @ApiMember(Description="Api Authentication Key", IsRequired=true, ParameterType="query")
        public String ApiKey = null;

        /**
        * 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 String AcctToken = null;

        /**
        * 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.", IsRequired=true)
        public String ProfileToken = null;

        /**
        * When adding a Payment Profile that is 'on-file', the default behavior is to update the user's Payment TypePreference to the AcctClass of the new profile. If you wish to not update the preference, you can set`DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can be omitted or `false`.  For `IsTemp == true` profiles, `DoNotUpdatePaymentTypePreference` is ignored.
        */
        @ApiMember(Description="\r\nWhen adding a Payment Profile that is 'on-file', the default behavior is to update the user's Payment Type\r\nPreference to the AcctClass of the new profile. If you wish to not update the preference, you can set\r\n`DoNotUpdatePaymentTypePreference` to `true`. Otherwise, this can be omitted or `false`.  \r\n\r\nFor `IsTemp == true` profiles, `DoNotUpdatePaymentTypePreference` is ignored.")
        public Boolean DoNotUpdatePaymentTypePreference = null;

        /**
        * **Conditionally Required**  When adding a Payment Profile that has an OwnerType of `TempStUser`, the ownership will be changed to OwnerType of `User`with the `UserId` of the supplied `NewOwnerId`.
        */
        @ApiMember(Description="\r\n**Conditionally Required**  \r\n\r\nWhen adding a Payment Profile that has an OwnerType of `TempStUser`, the ownership will be changed to OwnerType of `User`\r\nwith the `UserId` of the supplied `NewOwnerId`.")
        public Integer NewOwnerId = null;
        
        public String getApiKey() { return ApiKey; }
        public PaymentProfileImportEndpoint setApiKey(String value) { this.ApiKey = value; return this; }
        public String getAcctToken() { return AcctToken; }
        public PaymentProfileImportEndpoint setAcctToken(String value) { this.AcctToken = value; return this; }
        public String getProfileToken() { return ProfileToken; }
        public PaymentProfileImportEndpoint setProfileToken(String value) { this.ProfileToken = value; return this; }
        public Boolean isDoNotUpdatePaymentTypePreference() { return DoNotUpdatePaymentTypePreference; }
        public PaymentProfileImportEndpoint setDoNotUpdatePaymentTypePreference(Boolean value) { this.DoNotUpdatePaymentTypePreference = value; return this; }
        public Integer getNewOwnerId() { return NewOwnerId; }
        public PaymentProfileImportEndpoint setNewOwnerId(Integer value) { this.NewOwnerId = value; return this; }
        private static Object responseType = PaymentProfileImportResponse.class;
        public Object getResponseType() { return responseType; }
    }

    public static class PaymentProfileImportResponse
    {
        public Boolean Success = null;
        public String Message = null;
        
        public Boolean isSuccess() { return Success; }
        public PaymentProfileImportResponse setSuccess(Boolean value) { this.Success = value; return this; }
        public String getMessage() { return Message; }
        public PaymentProfileImportResponse setMessage(String value) { this.Message = value; return this; }
    }

    public static interface IApiKeyEndpoint
    {
        public String ApiKey = null;
    }

    public static class PaymentProfileImportRequest
    {
        public String AcctToken = null;
        public String ProfileToken = null;
        public Boolean DoNotUpdatePaymentTypePreference = null;
        public ValueTuple<Integer,OwnerType> NewOwner = null;
        
        public String getAcctToken() { return AcctToken; }
        public PaymentProfileImportRequest setAcctToken(String value) { this.AcctToken = value; return this; }
        public String getProfileToken() { return ProfileToken; }
        public PaymentProfileImportRequest setProfileToken(String value) { this.ProfileToken = value; return this; }
        public Boolean isDoNotUpdatePaymentTypePreference() { return DoNotUpdatePaymentTypePreference; }
        public PaymentProfileImportRequest setDoNotUpdatePaymentTypePreference(Boolean value) { this.DoNotUpdatePaymentTypePreference = value; return this; }
        public ValueTuple<Integer,OwnerType> getNewOwner() { return NewOwner; }
        public PaymentProfileImportRequest setNewOwner(ValueTuple<Integer,OwnerType> value) { this.NewOwner = value; return this; }
    }

}