/* Options:
Date: 2026-05-25 03:11:52
Version: 10.06
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://active-ewebservice.biz/aeservices30/api

//GlobalNamespace: 
//MakePropertiesOptional: False
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddImplicitVersion: 
//AddDescriptionAsComments: True
IncludeTypes: C2BGetInstrumentDetailRequest.*
//ExcludeTypes: 
//DefaultImports: 
*/

// @ts-nocheck

export interface IReturn<T>
{
    createResponse(): T;
}

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    public ApiKey: string;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token?: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class C2BDistrictGeneric
{
    // @DataMember
    public DistrictName?: string;

    // @DataMember
    public SchoolCount: number;

    // @DataMember
    public TeacherCount: number;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Id: number;

    // @DataMember
    public State?: string;

    public constructor(init?: Partial<C2BDistrictGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BPlanCodeGeneric
{
    // @DataMember
    public Code?: string;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Months: number;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Url?: string;

    // @DataMember
    public FinalTopic?: string;

    public constructor(init?: Partial<C2BPlanCodeGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BDeliveryInfo
{
    // @DataMember
    public FirstDelivery: string;

    // @DataMember
    public DeliveryTime: string;

    // @DataMember
    public DeliveryThreshold: number;

    // @DataMember
    public SundayDelivery: boolean;

    // @DataMember
    public MondayDelivery: boolean;

    // @DataMember
    public TuesdayDelivery: boolean;

    // @DataMember
    public WednesdayDelivery: boolean;

    // @DataMember
    public ThursdayDelivery: boolean;

    // @DataMember
    public FridayDelivery: boolean;

    // @DataMember
    public SaturdayDelivery: boolean;

    public constructor(init?: Partial<C2BDeliveryInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BTeacherGeneric
{
    // @DataMember
    public TeacherName?: string;

    // @DataMember
    public SchoolName?: string;

    // @DataMember
    public DistrictName?: string;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Id: number;

    // @DataMember
    public DeliveryInfo?: C2BDeliveryInfo;

    // @DataMember
    public AIMSchoolId?: number;

    public constructor(init?: Partial<C2BTeacherGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BSchoolGeneric
{
    // @DataMember
    public SchoolName?: string;

    // @DataMember
    public DistrictName?: string;

    // @DataMember
    public TeacherCount: number;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Id: number;

    // @DataMember
    public DeliveryInfo?: C2BDeliveryInfo;

    // @DataMember
    public AIMSchoolId?: number;

    public constructor(init?: Partial<C2BSchoolGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BGradeGeneric
{
    // @DataMember
    public Level: number;

    // @DataMember
    public Grade?: string;

    // @DataMember
    public DownPay: number;

    // @DataMember
    public DownMaint: number;

    // @DataMember
    public MoPay: number;

    // @DataMember
    public MoMaint: number;

    // @DataMember
    public Id: number;

    // @DataMember
    public OutOfStock: boolean;

    // @DataMember
    public RentPrice: number;

    // @DataMember
    public CashPrice: number;

    // @DataMember
    public DownPayTax?: number;

    // @DataMember
    public DownMaintTax?: number;

    // @DataMember
    public MoPayTax?: number;

    // @DataMember
    public MoMaintTax?: number;

    // @DataMember
    public RentPricePlusTax: number;

    // @DataMember
    public RentPricePlusTaxLessDownpay: number;

    // @DataMember
    public Months: number;

    public constructor(init?: Partial<C2BGradeGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BAccessoryGeneric
{
    // @DataMember
    public AccessoryDesc?: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public Required: boolean;

    // @DataMember
    public Default: boolean;

    // @DataMember
    public RequiresLocation: boolean;

    // @DataMember
    public Type?: string;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Id: number;

    // @DataMember
    public DisplayOrder: number;

    // @DataMember
    public Sku?: string;

    // @DataMember
    public TaxAmount?: number;

    // @DataMember
    public CatNum?: number;

    public constructor(init?: Partial<C2BAccessoryGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BInstrumentGeneric
{
    // @DataMember
    public InstrumentName?: string;

    // @DataMember
    public Sku?: string;

    // @DataMember
    public Topic?: string;

    // @DataMember
    public Image?: string;

    // @DataMember
    public Level: number;

    // @DataMember
    public RentPrice?: number;

    // @DataMember
    public CashPrice?: number;

    // @DataMember
    public Token?: string;

    // @DataMember
    public InstrumentId: number;

    // @DataMember
    public InstrumentTeacherId: number;

    // @DataMember
    public GradeList?: C2BGradeGeneric[];

    // @DataMember
    public HasGrades: boolean;

    // @DataMember
    public DisplayOrder: number;

    // @DataMember
    public AccessoryList?: C2BAccessoryGeneric[];

    // @DataMember
    public DeliveryList?: C2BAccessoryGeneric[];

    // @DataMember
    public MaintenanceList?: C2BAccessoryGeneric[];

    public constructor(init?: Partial<C2BInstrumentGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BInstrumentDetailGeneric
{
    // @DataMember
    public PlanCode?: C2BPlanCodeGeneric;

    // @DataMember
    public Teacher?: C2BTeacherGeneric;

    // @DataMember
    public School?: C2BSchoolGeneric;

    // @DataMember
    public DeliveryDate?: string;

    // @DataMember
    public SalesPerson?: string;

    // @DataMember
    public District?: C2BDistrictGeneric;

    // @DataMember
    public Instrument?: C2BInstrumentGeneric;

    // @DataMember
    public Grade?: C2BGradeGeneric;

    // @DataMember
    public AccessoryList?: C2BAccessoryGeneric[];

    // @DataMember
    public DeliveryList?: C2BAccessoryGeneric[];

    // @DataMember
    public MaintenanceList?: C2BAccessoryGeneric[];

    public constructor(init?: Partial<C2BInstrumentDetailGeneric>) { (Object as any).assign(this, init); }
}

// @DataContract
export class MobileLayout
{
    // @DataMember
    public title?: string;

    // @DataMember
    public returnurl?: string;

    // @DataMember
    public sections?: Section[];

    public constructor(init?: Partial<MobileLayout>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status?: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BGetInstrumentDetailResponse extends BaseResponse
{
    // @DataMember
    public InstrumentDetails?: C2BInstrumentDetailGeneric;

    // @DataMember
    public MobileLayout?: MobileLayout;

    public constructor(init?: Partial<C2BGetInstrumentDetailResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description C2BGetInstrumentDetailRequires active-e Contracts Service. */
// @Route("/C2BGetInstrumentDetail", "POST, GET")
// @DataContract
export class C2BGetInstrumentDetailRequest extends BaseSecureRequest implements IReturn<C2BGetInstrumentDetailResponse>
{
    /** @description ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.", Format="int64", Name="RsiPk", ParameterType="query")
    public RsiPk?: number;

    /** @description ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")
    public TeacherId?: number;

    /** @description ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")
    public InstrumentId?: number;

    /** @description ID of the Rate to be used. This is required. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")
    public RateId: number;

    /** @description If 'Y', then Mobile Layout will be returned. */
    // @DataMember
    // @ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")
    public IncludeMobileLayout?: string;

    /** @description ID of the Delivery option to be used. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")
    public DeliveryId: number;

    /** @description ID of the Location. Used for Location required Delivery options. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
    public LocationId: number;

    public constructor(init?: Partial<C2BGetInstrumentDetailRequest>) { super(init); (Object as any).assign(this, init); }
    public getTypeName() { return 'C2BGetInstrumentDetailRequest'; }
    public getMethod() { return 'POST'; }
    public createResponse() { return new C2BGetInstrumentDetailResponse(); }
}