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

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: CreateProspectRequest.*
//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="/users/prospect", Verbs="POST")
    public static class CreateProspectRequest extends CreateProspectRequestDto implements IRestrictedApiRequest
    {
        /**
        * Api Key - grants access to resources
        */
        @ApiMember(DataType="string", Description="Api Key - grants access to resources", IsRequired=true, Name="ApiKey", ParameterType="query")
        public String ApiKey = null;

        /**
        * ClubReady Club ID (StoreID internally)
        */
        @ApiMember(DataType="integer", Description="ClubReady Club ID (StoreID internally)", IsRequired=true, Name="StoreId", ParameterType="query")
        public Integer StoreId = null;

        /**
        * First Name
        */
        @ApiMember(DataType="string", Description="First Name", IsRequired=true, Name="FirstName", ParameterType="query")
        public String FirstName = null;

        /**
        * Last Name
        */
        @ApiMember(DataType="string", Description="Last Name", IsRequired=true, Name="LastName", ParameterType="query")
        public String LastName = null;

        /**
        * Email Address
        */
        @ApiMember(DataType="string", Description="Email Address", IsRequired=true, Name="Email", ParameterType="query")
        public String Email = null;

        /**
        * Gender (Format:'M'|'F')
        */
        @ApiMember(DataType="string", Description="Gender (Format:'M'|'F')", Name="Gender", ParameterType="query")
        public String Gender = null;

        /**
        * Address
        */
        @ApiMember(DataType="string", Description="Address", Name="Address", ParameterType="query")
        public String Address = null;

        /**
        * City
        */
        @ApiMember(DataType="string", Description="City", Name="City", ParameterType="query")
        public String City = null;

        @ApiMember(DataType="string", Name="State", ParameterType="query")
        public String State = null;

        @ApiMember(DataType="string", Name="Zip", ParameterType="query")
        public String Zip = null;

        /**
        * Home phone
        */
        @ApiMember(DataType="string", Description="Home phone", Name="Phone", ParameterType="query")
        public String Phone = null;

        /**
        * Work phone
        */
        @ApiMember(DataType="string", Description="Work phone", Name="WorkPhone", ParameterType="query")
        public String WorkPhone = null;

        /**
        * Date of Birth (Format:YYYY-MM-DD)
        */
        @ApiMember(DataType="date", Description="Date of Birth (Format:YYYY-MM-DD)", Name="DateOfBirth", ParameterType="query")
        public Date DateOfBirth = null;

        /**
        * Cell phone
        */
        @ApiMember(DataType="string", Description="Cell phone", Name="CellPhone", ParameterType="query")
        public String CellPhone = null;

        /**
        * Specify a Package to apply to the new prospect
        */
        @ApiMember(DataType="integer", Description="Specify a Package to apply to the new prospect", Name="AddPackageId", ParameterType="query")
        public Integer AddPackageId = null;

        /**
        * Specify a specific Prospect Type for the new prospect
        */
        @ApiMember(DataType="integer", Description="Specify a specific Prospect Type for the new prospect", Name="ProspectTypeId", ParameterType="query")
        public Integer ProspectTypeId = null;

        /**
        * Specify a specific Referral Type for the new prospect
        */
        @ApiMember(DataType="integer", Description="Specify a specific Referral Type for the new prospect", Name="ReferralTypeId", ParameterType="query")
        public Integer ReferralTypeId = null;

        /**
        * Send a Welcome email to the new prospect (Format:true|false)
        */
        @ApiMember(DataType="boolean", Description="Send a Welcome email to the new prospect (Format:true|false)", IsRequired=true, Name="SendEmail", ParameterType="query")
        public Boolean SendEmail = null;

        /**
        * Only used if SendEmail = True
        */
        @ApiMember(DataType="integer", Description="Only used if SendEmail = True", Name="EmailTemplateId", ParameterType="query")
        public Integer EmailTemplateId = null;

        /**
        * 
        */
        @ApiMember(DataType="string", Description="", Name="Coupon", ParameterType="query")
        public String Coupon = null;

        /**
        * Add an internal note for the new prospect
        */
        @ApiMember(DataType="string", Description="Add an internal note for the new prospect", Name="Note", ParameterType="query")
        public String Note = null;

        /**
        * Unique ID for the user from your system. We store internally as ExternalUserId
        */
        @ApiMember(DataType="string", Description="Unique ID for the user from your system. We store internally as ExternalUserId", Name="ExternalId", ParameterType="query")
        public String ExternalId = null;

        /**
        * User ID of existing user who referred them.
        */
        @ApiMember(DataType="integer", Description="User ID of existing user who referred them.", Name="ReferredBy", ParameterType="query")
        public Integer ReferredBy = null;

        /**
        * ClubReady UserId of staff to assign new member to.
        */
        @ApiMember(DataType="integer", Description="ClubReady UserId of staff to assign new member to.", Name="AssignToId", ParameterType="query")
        public Integer AssignToId = null;

        /**
        * Who should be assigned to this lead? 0 = Default lead assignments, 1 = When passing in a ReferredBy user, assign the new Lead to that referring user's Staff assignment.
        */
        @ApiMember(DataType="integer", Description="Who should be assigned to this lead? 0 = Default lead assignments, 1 = When passing in a ReferredBy user, assign the new Lead to that referring user's Staff assignment.", Name="AssignToMethod", ParameterType="query")
        public Integer AssignToMethod = null;

        /**
        * Username needs to be between 4 and 255 characters
        */
        @ApiMember(DataType="string", Description="Username needs to be between 4 and 255 characters", Name="Username", ParameterType="query")
        public String Username = null;

        /**
        * Emergency contact name
        */
        @ApiMember(DataType="string", Description="Emergency contact name", Name="EmergencyContactName", ParameterType="query")
        public String EmergencyContactName = null;

        /**
        * Emergency contact phone number
        */
        @ApiMember(DataType="string", Description="Emergency contact phone number", Name="EmergencyContactPhone", ParameterType="query")
        public String EmergencyContactPhone = null;

        /**
        * Emergency contact relationship
        */
        @ApiMember(DataType="string", Description="Emergency contact relationship", Name="EmergencyContactType", ParameterType="query")
        public String EmergencyContactType = null;

        /**
        * Set a prospect's email opt out status (Format:true|false)
        */
        @ApiMember(DataType="boolean", Description="Set a prospect's email opt out status (Format:true|false)", Name="EmailOptOut", ParameterType="query")
        public Boolean EmailOptOut = null;

        /**
        * Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)
        */
        @ApiMember(DataType="boolean", Description="Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)", Name="NonPromotionalSmsOptedIn", ParameterType="query")
        public Boolean NonPromotionalSmsOptedIn = null;

        /**
        * Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)
        */
        @ApiMember(DataType="boolean", Description="Set a prospect's NonPromotionalSmsOptedIn status (Format:true|false)", Name="PromotionalSmsOptedIn", ParameterType="query")
        public Boolean PromotionalSmsOptedIn = null;

        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
        
        public String getApiKey() { return ApiKey; }
        public CreateProspectRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public CreateProspectRequest setStoreId(Integer value) { this.StoreId = value; return this; }
        public String getFirstName() { return FirstName; }
        public CreateProspectRequest setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public CreateProspectRequest setLastName(String value) { this.LastName = value; return this; }
        public String getEmail() { return Email; }
        public CreateProspectRequest setEmail(String value) { this.Email = value; return this; }
        public String getGender() { return Gender; }
        public CreateProspectRequest setGender(String value) { this.Gender = value; return this; }
        public String getAddress() { return Address; }
        public CreateProspectRequest setAddress(String value) { this.Address = value; return this; }
        public String getCity() { return City; }
        public CreateProspectRequest setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public CreateProspectRequest setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public CreateProspectRequest setZip(String value) { this.Zip = value; return this; }
        public String getPhone() { return Phone; }
        public CreateProspectRequest setPhone(String value) { this.Phone = value; return this; }
        public String getWorkPhone() { return WorkPhone; }
        public CreateProspectRequest setWorkPhone(String value) { this.WorkPhone = value; return this; }
        public Date getDateOfBirth() { return DateOfBirth; }
        public CreateProspectRequest setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
        public String getCellPhone() { return CellPhone; }
        public CreateProspectRequest setCellPhone(String value) { this.CellPhone = value; return this; }
        public Integer getAddPackageId() { return AddPackageId; }
        public CreateProspectRequest setAddPackageId(Integer value) { this.AddPackageId = value; return this; }
        public Integer getProspectTypeId() { return ProspectTypeId; }
        public CreateProspectRequest setProspectTypeId(Integer value) { this.ProspectTypeId = value; return this; }
        public Integer getReferralTypeId() { return ReferralTypeId; }
        public CreateProspectRequest setReferralTypeId(Integer value) { this.ReferralTypeId = value; return this; }
        public Boolean isSendEmail() { return SendEmail; }
        public CreateProspectRequest setSendEmail(Boolean value) { this.SendEmail = value; return this; }
        public Integer getEmailTemplateId() { return EmailTemplateId; }
        public CreateProspectRequest setEmailTemplateId(Integer value) { this.EmailTemplateId = value; return this; }
        public String getCoupon() { return Coupon; }
        public CreateProspectRequest setCoupon(String value) { this.Coupon = value; return this; }
        public String getNote() { return Note; }
        public CreateProspectRequest setNote(String value) { this.Note = value; return this; }
        public String getExternalId() { return ExternalId; }
        public CreateProspectRequest setExternalId(String value) { this.ExternalId = value; return this; }
        public Integer getReferredBy() { return ReferredBy; }
        public CreateProspectRequest setReferredBy(Integer value) { this.ReferredBy = value; return this; }
        public Integer getAssignToId() { return AssignToId; }
        public CreateProspectRequest setAssignToId(Integer value) { this.AssignToId = value; return this; }
        public Integer getAssignToMethod() { return AssignToMethod; }
        public CreateProspectRequest setAssignToMethod(Integer value) { this.AssignToMethod = value; return this; }
        public String getUsername() { return Username; }
        public CreateProspectRequest setUsername(String value) { this.Username = value; return this; }
        public String getEmergencyContactName() { return EmergencyContactName; }
        public CreateProspectRequest setEmergencyContactName(String value) { this.EmergencyContactName = value; return this; }
        public String getEmergencyContactPhone() { return EmergencyContactPhone; }
        public CreateProspectRequest setEmergencyContactPhone(String value) { this.EmergencyContactPhone = value; return this; }
        public String getEmergencyContactType() { return EmergencyContactType; }
        public CreateProspectRequest setEmergencyContactType(String value) { this.EmergencyContactType = value; return this; }
        public Boolean isEmailOptOut() { return EmailOptOut; }
        public CreateProspectRequest setEmailOptOut(Boolean value) { this.EmailOptOut = value; return this; }
        public Boolean isNonPromotionalSmsOptedIn() { return NonPromotionalSmsOptedIn; }
        public CreateProspectRequest setNonPromotionalSmsOptedIn(Boolean value) { this.NonPromotionalSmsOptedIn = value; return this; }
        public Boolean isPromotionalSmsOptedIn() { return PromotionalSmsOptedIn; }
        public CreateProspectRequest setPromotionalSmsOptedIn(Boolean value) { this.PromotionalSmsOptedIn = value; return this; }
        public Integer getRestrictedId() { return RestrictedId; }
        public CreateProspectRequest setRestrictedId(Integer value) { this.RestrictedId = value; return this; }
        public RestrictedResourceType getRestrictedResourceType() { return RestrictedResourceType; }
        public CreateProspectRequest setRestrictedResourceType(RestrictedResourceType value) { this.RestrictedResourceType = value; return this; }
    }

    public static enum RestrictedResourceType
    {
        Store,
        Chain,
        User,
        Undefined;
    }

    public static interface IRestrictedApiRequest implements IApiKeyEndpoint
    {
        public Integer RestrictedId = null;
        public RestrictedResourceType RestrictedResourceType = null;
    }

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

    public static class ApiDtoBase
    {
        public String ApiKey = null;
        public Integer StoreId = null;
        public Integer ChainId = null;
        
        public String getApiKey() { return ApiKey; }
        public ApiDtoBase setApiKey(String value) { this.ApiKey = value; return this; }
        public Integer getStoreId() { return StoreId; }
        public ApiDtoBase setStoreId(Integer value) { this.StoreId = value; return this; }
        public Integer getChainId() { return ChainId; }
        public ApiDtoBase setChainId(Integer value) { this.ChainId = value; return this; }
    }

    public static class CreateProspectRequestDto extends ApiDtoBase
    {
        public String FirstName = null;
        public String LastName = null;
        public String Address = null;
        public String City = null;
        public String State = null;
        public String Zip = null;
        public String Email = null;
        public String Gender = null;
        public Integer AddPackageId = null;
        public Integer ProspectTypeId = null;
        public Integer ReferralTypeId = null;
        public Boolean SendEmail = null;
        public String Phone = null;
        public String WorkPhone = null;
        public Date DateOfBirth = null;
        public String CellPhone = null;
        public String Coupon = null;
        public String Note = null;
        public Integer EmailTemplateId = null;
        public String ExternalId = null;
        public Integer ReferredBy = null;
        public Integer AssignToId = null;
        public Integer AssignToMethod = null;
        public Integer ContactedHow = null;
        public String Username = null;
        public String EmergencyContactName = null;
        public String EmergencyContactPhone = null;
        public String EmergencyContactType = null;
        public Boolean EmailOptOut = null;
        public Boolean NonPromotionalSmsOptedIn = null;
        public Boolean PromotionalSmsOptedIn = null;
        
        public String getFirstName() { return FirstName; }
        public CreateProspectRequestDto setFirstName(String value) { this.FirstName = value; return this; }
        public String getLastName() { return LastName; }
        public CreateProspectRequestDto setLastName(String value) { this.LastName = value; return this; }
        public String getAddress() { return Address; }
        public CreateProspectRequestDto setAddress(String value) { this.Address = value; return this; }
        public String getCity() { return City; }
        public CreateProspectRequestDto setCity(String value) { this.City = value; return this; }
        public String getState() { return State; }
        public CreateProspectRequestDto setState(String value) { this.State = value; return this; }
        public String getZip() { return Zip; }
        public CreateProspectRequestDto setZip(String value) { this.Zip = value; return this; }
        public String getEmail() { return Email; }
        public CreateProspectRequestDto setEmail(String value) { this.Email = value; return this; }
        public String getGender() { return Gender; }
        public CreateProspectRequestDto setGender(String value) { this.Gender = value; return this; }
        public Integer getAddPackageId() { return AddPackageId; }
        public CreateProspectRequestDto setAddPackageId(Integer value) { this.AddPackageId = value; return this; }
        public Integer getProspectTypeId() { return ProspectTypeId; }
        public CreateProspectRequestDto setProspectTypeId(Integer value) { this.ProspectTypeId = value; return this; }
        public Integer getReferralTypeId() { return ReferralTypeId; }
        public CreateProspectRequestDto setReferralTypeId(Integer value) { this.ReferralTypeId = value; return this; }
        public Boolean isSendEmail() { return SendEmail; }
        public CreateProspectRequestDto setSendEmail(Boolean value) { this.SendEmail = value; return this; }
        public String getPhone() { return Phone; }
        public CreateProspectRequestDto setPhone(String value) { this.Phone = value; return this; }
        public String getWorkPhone() { return WorkPhone; }
        public CreateProspectRequestDto setWorkPhone(String value) { this.WorkPhone = value; return this; }
        public Date getDateOfBirth() { return DateOfBirth; }
        public CreateProspectRequestDto setDateOfBirth(Date value) { this.DateOfBirth = value; return this; }
        public String getCellPhone() { return CellPhone; }
        public CreateProspectRequestDto setCellPhone(String value) { this.CellPhone = value; return this; }
        public String getCoupon() { return Coupon; }
        public CreateProspectRequestDto setCoupon(String value) { this.Coupon = value; return this; }
        public String getNote() { return Note; }
        public CreateProspectRequestDto setNote(String value) { this.Note = value; return this; }
        public Integer getEmailTemplateId() { return EmailTemplateId; }
        public CreateProspectRequestDto setEmailTemplateId(Integer value) { this.EmailTemplateId = value; return this; }
        public String getExternalId() { return ExternalId; }
        public CreateProspectRequestDto setExternalId(String value) { this.ExternalId = value; return this; }
        public Integer getReferredBy() { return ReferredBy; }
        public CreateProspectRequestDto setReferredBy(Integer value) { this.ReferredBy = value; return this; }
        public Integer getAssignToId() { return AssignToId; }
        public CreateProspectRequestDto setAssignToId(Integer value) { this.AssignToId = value; return this; }
        public Integer getAssignToMethod() { return AssignToMethod; }
        public CreateProspectRequestDto setAssignToMethod(Integer value) { this.AssignToMethod = value; return this; }
        public Integer getContactedHow() { return ContactedHow; }
        public CreateProspectRequestDto setContactedHow(Integer value) { this.ContactedHow = value; return this; }
        public String getUsername() { return Username; }
        public CreateProspectRequestDto setUsername(String value) { this.Username = value; return this; }
        public String getEmergencyContactName() { return EmergencyContactName; }
        public CreateProspectRequestDto setEmergencyContactName(String value) { this.EmergencyContactName = value; return this; }
        public String getEmergencyContactPhone() { return EmergencyContactPhone; }
        public CreateProspectRequestDto setEmergencyContactPhone(String value) { this.EmergencyContactPhone = value; return this; }
        public String getEmergencyContactType() { return EmergencyContactType; }
        public CreateProspectRequestDto setEmergencyContactType(String value) { this.EmergencyContactType = value; return this; }
        public Boolean isEmailOptOut() { return EmailOptOut; }
        public CreateProspectRequestDto setEmailOptOut(Boolean value) { this.EmailOptOut = value; return this; }
        public Boolean isNonPromotionalSmsOptedIn() { return NonPromotionalSmsOptedIn; }
        public CreateProspectRequestDto setNonPromotionalSmsOptedIn(Boolean value) { this.NonPromotionalSmsOptedIn = value; return this; }
        public Boolean isPromotionalSmsOptedIn() { return PromotionalSmsOptedIn; }
        public CreateProspectRequestDto setPromotionalSmsOptedIn(Boolean value) { this.PromotionalSmsOptedIn = value; return this; }
    }

}