/* Options:
Date: 2025-04-04 17:55:27
Version: 5.140
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://api.clubmanagercentral.com

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

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


@Route(Path="/api/Branch/GetBranchByKey", Verbs="POST,GET")
open class GetBranchByKeyRequest : IReturn<Branch>
{
    var BranchKey:UUID? = null
    companion object { private val responseType = Branch::class.java }
    override fun getResponseType(): Any? = GetBranchByKeyRequest.responseType
}

open class Branch
{
    var BranchId:Int? = null
    var BranchType:BranchType? = null
    var Name:String? = null
    var Prefix:String? = null
    var CompanyName:String? = null
    var CompanyAddress:String? = null
    var CompanyOfficialName:String? = null
    var DirectDebitReference:String? = null
    var FastDDReference:String? = null
    var FastDDPlatinumRef:String? = null
    var Style:String? = null
    var PublicKey:UUID? = null
    var PrivateKey:UUID? = null
    var TrialStart:Date? = null
    var TrialEnd:Date? = null
    var PaymentStartDate:Date? = null
    var InTrial:Boolean? = null
    var UseFreeText:Boolean? = null
    var FreeTextTitle:String? = null
    var UseMembershipTypes:Boolean? = null
    var DDUserName:String? = null
    var DDPassword:String? = null
    var DDServiceUser:String? = null
    var DfcUserName:String? = null
    var DfcPassword:String? = null
    var DfcClubNumber:String? = null
    var CompanyEmail:String? = null
    var SmsOriginator:String? = null
    var LanguageId:Int? = null
    var VatRate:BigDecimal? = null
    var SwipeAction:Int? = null
    var Modules:Module? = null
    var UseCreditBalance:Boolean? = null
    var AllowNegativeBalance:Boolean? = null
    var DefaultCreditLimit:BigDecimal? = null
    var ApplicationType:ApplicationType? = null
    var ExternalProviderWarning:String? = null
    var Domain:String? = null
    var MobileDomain:String? = null
    var OnlineBookingTimetableLimit:Int? = null
    var OnlineBookingCancellationLimit:Int? = null
    var OnlineBookingLimit:Int? = null
    var Feature:Feature? = null
    var TimeZone:String? = null
    var Culture:String? = null
    var Country:String? = null
    var Iso3166Country:Iso3166Country? = null
    var CurrencyCulture:String? = null
    var ShowGoCardlessAd:Boolean? = null
    var GoCardlessSaving:BigDecimal? = null
    var SROAddress:String? = null
    var MCAClubNo:String? = null
    var MCAClubRef:String? = null
    var TwilioNumber:String? = null
    var Telephone:String? = null
    var Transferred:Boolean? = null
    var OnlineBookingAllowNonActives:Boolean? = null
    var MemberLimit:Int? = null
    var SortCode:String? = null
    var AccountNumber:String? = null
    var Website:String? = null
    var SendSMSAppointmentRemindersDefault:Boolean? = null
    var SendSMSBookingReminders:Boolean? = null
    var GiftAid:Boolean? = null
    var GlobalBookingStartTime:TimeSpan? = null
    var GlobalBookingEndTime:TimeSpan? = null
    var BookingMinuteIncrements:Int? = null
    var CancelReason:String? = null
    var CancelFurther:String? = null
    var CancelDate:Date? = null
    var DirectDebitFee:BigDecimal? = null
    var CreditCardFee:BigDecimal? = null
    var SMSPriceAdjustment:BigDecimal? = null
    var BookingsPayLinkOnTrack:Boolean? = null
    var AccessControlTimeLimit:Int? = null
    var Minimiser:BranchMinimiser? = null
    var AutoGenerateLicenses:Boolean? = null
    var Terms:String? = null
    var FingerprintThreshold:Int? = null
    var FingerprintMatcherThreshold:Int? = null
    var AutoShutoff:Boolean? = null
    var PrimaryColors:String? = null
    var HasColors:Boolean? = null
    var PrimaryColor:String? = null
    var SecondaryColor:String? = null
    var BackgroundColor:String? = null
    var HeaderTopColor:String? = null
    var HeaderBottomColor:String? = null
    var SideLeftColor:String? = null
    var SideRightColor:String? = null
    var SideFontColor:String? = null
    var SideFontActiveColor:String? = null
    var ExtWebBackgroundColor:String? = null
    var ExtWebTextColor:String? = null
    var ExtWebTintBackColor:String? = null
    var ExtWebHighlightBackColor:String? = null
    var ExtWebTabBackColor:String? = null
    var HeadingColor:String? = null
    var ReportFormat:ReportFormat? = null
    var FixPayments:Boolean? = null
    var FixPaymentSchedle:String? = null
    var AppFeature:AppFeature? = null
    var SignInScreenFeature:SignInScreenFeature? = null
    var AppOptions:String? = null
    var CompanyDescription:String? = null
    var Capacity:Int? = null
    var MonthlySalesTarget:Int? = null
    var BookingAccessTimeLimit:Int? = null
    var Facebook:String? = null
    var Twitter:String? = null
    var Instagram:String? = null
    var YouTube:String? = null
    var TikTok:String? = null
    var Shopify:String? = null
    var MinimumMemberAge:Int? = null
    var TermsAndConditionsVersionDate:Date? = null
    var TermsAndConditionsAcceptedDate:Date? = null
    var TermsAndConditionsAccepted:Boolean? = null
    var SiteUrl:String? = null
    var IsUsingSmartDebit:Boolean? = null
    var IsUsingDfc:Boolean? = null
    var IsSouthAfrica:Boolean? = null
    var SmartDebitConfigured:Boolean? = null
    var DfcConfigured:Boolean? = null
    var UsingPaymentMethods:Boolean? = null
    var SmsPrefix:String? = null
    var Logo:String? = null
    var LogoThumbnail:String? = null
    var LogoHash:String? = null
    var SendMarketingInviteWhenMemberAdded:Boolean? = null
    var SendMarketingInviteWhenMemberJoinedOnline:Boolean? = null
    var MarketingComplianceManagedExternally:Boolean? = null
    var OnlineBookingAllowWaitingList:Boolean? = null
    var OnlineMultiSiteEnabled:Boolean? = null
    var CanBookOnline:Boolean? = null
    var PublicMembershipTypes:Int? = null
    var TrustedBranches:Int? = null
    var IsAddingProspects:Boolean? = null
    var IsSellingMemberships:Boolean? = null
    var IsCreatingTasks:Boolean? = null
    var IsCreatingAppointments:Boolean? = null
    var IsBookingClasses:Boolean? = null
    var IsRegisteringAttendance:Boolean? = null
    var IsSellingProducts:Boolean? = null
    var IsSendingEmails:Boolean? = null
    var IsSendingSMS:Boolean? = null
    var IsUsingAutomation:Boolean? = null
    var DeductSessionsOnBooking:Boolean? = null
    var ShowTrustedBranchBookings:Boolean? = null
    var Score:Int? = null
    var ApplicationId:String? = null
    var iOSAppLink:String? = null
    var AndroidAppLink:String? = null
}

enum class BranchType
{
    DebitFinance,
    SmartDebit,
    Standard,
    Root,
    Reseller,
    Referrer,
}

@Flags()
enum class Module(val value:Int)
{
    @SerializedName("0") Standard(0),
    @SerializedName("1") Bookings(1),
}

enum class ApplicationType(val value:Int)
{
    Gym(1),
    Golf(2),
    Dance(3),
    Soccer(4),
    Vanilla(5),
    Association(6),
    MartialArts(7),
    Gymnastics(8),
    Swimming(9),
    Nurseries(10),
    Racquet(11),
    SubscriptionBox(12),
    Clinic(13),
    Wellness(14),
    HealthAndBeauty(15),
    Climbing(16),
    AfterSchoolClub(17),
    PersonalTrainer(18),
}

@Flags()
enum class Feature(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") Standard(1),
    @SerializedName("2") Bookings(2),
    @SerializedName("4") Rota(4),
    @SerializedName("8") GoCardless(8),
    @SerializedName("16") HomeScreen(16),
    @SerializedName("32") EPos(32),
    @SerializedName("64") Attendance(64),
    @SerializedName("128") Sales(128),
    @SerializedName("256") PaymentCollections(256),
    @SerializedName("512") MailChimp(512),
    @SerializedName("1024") MultiSite(1024),
    @SerializedName("2048") AccountingDashboard(2048),
    @SerializedName("4096") OtherDashboards(4096),
    @SerializedName("8192") Reports(8192),
    @SerializedName("16384") AdvancedAccounting(16384),
    @SerializedName("32768") MemberLicenseDates(32768),
    @SerializedName("65536") FaceRecognition(65536),
    @SerializedName("131072") MemberAccountCreation(131072),
    @SerializedName("262144") Automation(262144),
    @SerializedName("524288") FacebookMarketing(524288),
    @SerializedName("1048576") Grades(1048576),
    @SerializedName("2097152") ZoomIntegration(2097152),
    @SerializedName("4194304") SalesTargetChart(4194304),
    @SerializedName("8388608") CustomApp(8388608),
    @SerializedName("16777216") CustomAttributesOnPortal(16777216),
    @SerializedName("33554432") NoExport(33554432),
    @SerializedName("67108864") EnterpriseClubPerformanceDashboards(67108864),
}

open class Iso3166Country
{
    var Name:String? = null
    var TwoLetterCode:String? = null
    var ThreeLetterCode:String? = null
    var NumericCode:Int? = null
    var PhonePrefix:ArrayList<String>? = null
}

enum class BranchMinimiser
{
    None,
    CmGo,
    BasicPortal,
}

enum class ReportFormat(val value:Int)
{
    Pdf(1),
    Word(2),
    Excel(3),
    Png(4),
    Xps(5),
    Csv(6),
    Html5(7),
}

@Flags()
enum class AppFeature(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") JoinOnline(1),
    @SerializedName("2") TodaysClasses(2),
    @SerializedName("4") RegistrationForm(4),
    @SerializedName("8") ForthcomingBookings(8),
    @SerializedName("16") WeeklyTimetable(16),
    @SerializedName("32") SessionTimetable(32),
    @SerializedName("64") FacilityTimetable(64),
    @SerializedName("128") TasterSessions(128),
    @SerializedName("256") HowToFindUs(256),
    @SerializedName("512") AttendanceLeaderboard(512),
    @SerializedName("1024") MemberMessages(1024),
    @SerializedName("2048") AchievementGallery(2048),
    @SerializedName("4096") FreeText(4096),
    @SerializedName("8192") QrCode(8192),
    @SerializedName("16384") ShareAndInviteAFriend(16384),
    @SerializedName("32768") RenewalPrompt(32768),
    @SerializedName("65536") CurrentCapacity(65536),
    @SerializedName("131072") JoinFriend(131072),
    @SerializedName("262144") MemberPoints(262144),
    @SerializedName("524288") PromoMembership(524288),
    @SerializedName("1048576") Shop(1048576),
    @SerializedName("2097152") ShowFacebook(2097152),
    @SerializedName("4194304") ShowTwitter(4194304),
    @SerializedName("8388608") ShowInstagram(8388608),
    @SerializedName("16777216") ShowYouTube(16777216),
    @SerializedName("33554432") ShowTikTok(33554432),
    @SerializedName("67108864") ShowShopify(67108864),
    @SerializedName("134217728") AttendanceStreak(134217728),
    @SerializedName("268435456") BookingCategories(268435456),
    @SerializedName("536870912") ShowSessionsRemaining(536870912),
}

@Flags()
enum class SignInScreenFeature(val value:Int)
{
    @SerializedName("0") None(0),
    @SerializedName("1") SignInNumPad(1),
}