/* Options:
Date: 2026-02-14 11:42:41
Version: 10.04
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://stf-api-uat.data-xchange.co.za

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


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

export interface IReturnVoid
{
    createResponse(): void;
}

export interface IGetDocumentById extends ISingleEntityQuery
{
}

export interface ISingleEntityQuery
{
    id: string;
}

// @DataContract
export class DocumentIdentification
{
    // @DataMember(Name="identifier")
    public identifier: string;

    // @DataMember(Name="type")
    public type: string;

    // @DataMember(Name="creationDateAndTime")
    public creationDateAndTime: string;

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

// @DataContract
export class Identifier
{
    // @DataMember(Name="authority")
    public authority: string;

    // @DataMember(Name="text")
    public text: string;

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

// @DataContract
export class ContactInformation
{

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

// @DataContract
export class Partner
{
    // @DataMember(Name="identifier")
    public identifier: Identifier;

    // @DataMember(Name="contactInformation")
    public contactInformation: ContactInformation[] = [];

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

// @DataContract
export class Header
{
    // @DataMember(Name="documentIdentification")
    public documentIdentification: DocumentIdentification;

    // @DataMember(Name="sender")
    public sender: Partner;

    // @DataMember(Name="receiver")
    public receiver: Partner;

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

export class AvpList
{
    public code: string;
    public value: string;

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

export class Ecom_PartyIdentificationType
{
    public gln: string;
    public name: string;
    public additionalPartyIdentification: AvpList[] = [];

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

export class CommunicationChannel
{
    public communicationChannelCode: string;
    public communicationChannelName: string;
    public communicationValue: string;

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

export class Contact
{
    public contactTypeCode: string;
    public personName: string;
    public departmentName: string;
    public jobTitle: string;
    public responsibility: string;
    public communicationChannel: CommunicationChannel[] = [];

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

export class Address
{
    public streetAddressOne: string;
    public streetAddressTwo: string;
    public streetAddressThree: string;
    public city: string;
    public postalCode: string;
    public provinceCode: string;
    public countryCode: string;

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

export class FinancialRoutingNumber
{
    public number: string;
    public numberTypeCode: string;

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

export class FinancialAccount
{
    public number: string;
    public numberTypeCode: string;
    public name: string;

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

export class FinancialInstitutionInformation
{
    public financialInstitutionBranchName: string;
    public financialInstitutionName: string;
    public financialRoutingNumber: FinancialRoutingNumber;
    public financialAccount: FinancialAccount;
    public swiftCode: string;
    public exportersCode: string;

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

export class TransactionalParty extends Ecom_PartyIdentificationType
{
    public contact: Contact[] = [];
    public address: Address;
    public communicationChannel: AvpList[] = [];
    public financialInstitutionInformation: FinancialInstitutionInformation;
    public dutyFeeTaxRegistration: string;
    public entityIdentification: string;

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

export enum DocumentAction
{
    ADD = 'ADD',
    CHANGE_BY_REFRESH = 'CHANGE_BY_REFRESH',
    DELETE = 'DELETE',
    REJECTED = 'REJECTED',
}

export enum DocumentStatus
{
    ADDITIONAL_TRANSMISSION = 'ADDITIONAL_TRANSMISSION',
    COPY = 'COPY',
    ORIGINAL = 'ORIGINAL',
}

export class BaseDocument
{
    public currencyCode: string;
    public creationDateTime: string;
    public documentActionCode: DocumentAction;
    public documentStatusCode: DocumentStatus;
    public documentStructureVersion: string;
    public lastUpdateDateTime?: string;
    public revisionNumber?: number;
    public avpList: AvpList[] = [];

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

export class Ecom_PartyIdentification
{
    public additionalPartyIdentification: AvpList[] = [];
    public gln: string;

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

export class Ecom_EntityIdentification
{
    public entityIdentification: string;
    public contentOwner: Ecom_PartyIdentification;

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

export class Code
{
    public value: string;
    public codeDescription: string;
    public codeListAgencyCodeListVersion: string;
    public codeListAgencyName: string;
    public codeListName: string;
    public codeListUri: string;

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

export class DateRange
{
    public beginDate?: string;
    public beginTime?: string;
    public endDate?: string;
    public endTime?: string;

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

export class OrderLogisticalDateInformation
{
    public dateRangeDeliveryDateRange: DateRange;
    public dateRangeShipDateRange: DateRange;
    public dateRangeDeliveryDateRangeAtUltimateConsignee: DateRange;
    public requestedDeliveryDateTime?: string;
    public requestedShipDateTime: string;
    public requestedPickUpDateTime?: string;
    public requestedDeliveryDateTimeAtUltimateConsignee?: string;

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

export class ShipmentTransportationInformation
{
    public carrier: TransactionalParty;
    public freightForwarder: TransactionalParty;

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

export class OrderLogisticalInformation
{
    public commodityTypeCode: Code;
    public orderLogisticalDateInformation: OrderLogisticalDateInformation;
    public inventoryLocation: TransactionalParty;
    public shipFrom: TransactionalParty;
    public shipTo: TransactionalParty;
    public ultimateConsignee: TransactionalParty;
    public shipmentTransportationInformation: ShipmentTransportationInformation;

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

export class AdministrativeUnit
{
    public typeCode: string;
    public gln: string;
    public internalIdentification: string;

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

export class DeliveryTermsLocation
{
    public unLocationCode: string;
    public gln: string;
    public additionalLocationIdentification: AvpList[] = [];
    public sublocationIdentification: string;
    public locationName: string;
    public locationSpecificInstructions: string;

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

export class DeliveryTerms
{
    public incotermsCode: string;
    public alternateDeliveryTermsCode: string;
    public deliveryInstructions: string;
    public deliveryCostPayment: string;
    public isSignatureRequired: string;
    public deliveryTermsLocation: DeliveryTermsLocation;

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

export class DocumentReference
{
    public creationDateTime?: string;
    public revisionNumber?: number;
    public lineItemNumber?: number;
    public entityIdentification: string;

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

export class ReferencedOrder
{
    public orderRelationship: string;
    public documentReference: DocumentReference;

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

export class AllowanceCharge
{
    public allowanceChargeAmount?: number;
    public allowanceChargePercentage?: number;
    public allowanceChargeType: string;
    public allowanceOrChargeType: string;
    public amountPerUnit?: number;
    public baseAmount?: number;
    public baseNumberOfUnits: string;
    public bracketIdentifier: string;
    public effectiveDateType?: string;
    public sequenceNumber: string;
    public settlementType: string;
    public specialServiceType: string;
    public allowanceChargeDescription: string;

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

export class Quantity
{
    public value?: number;
    public measurementUnitCode: string;
    public codeListVersion: string;

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

export class TransactionalItem
{
    public measurementUnitCode: string;
    public measurementType: string;
    public measurementValue: string;

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

export class SerialNumberRange
{
    public maximumValue: string;
    public minimumValue: string;

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

export class TransactionalItemDimension
{
    public measurementUnitCode: string;
    public depth: string;
    public height: string;
    public width: string;

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

export class TransactionalItemLogisticUnitInformation
{
    public numberOfLayers?: number;
    public numberOfUnitsPerLayer?: number;
    public numberOfUnitsPerPallet?: number;
    public packagingTerms: string;
    public packageTypeCode: string;
    public maximumStackingFactor?: number;
    public returnablePackageTransportCostPayment: string;
    public dimensionsOfLogisticUnit: TransactionalItemDimension[] = [];

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

export class TransactionalItemDataCarrierAndIdentification
{
    public gs1TransactionalItemIdentificationKey: string;
    public dataCarrier: string;

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

export class TradeItemWaste
{
    public wasteIdentification: string;
    public typeOfWaste: AvpList[] = [];

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

export class TransactionalItemOrganicInformation
{
    public isTradeItemOrganic?: boolean;
    public organicCertification: string;

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

export class TransactionalItemData
{
    public availableForSaleDate?: string;
    public batchNumber: string;
    public bestBeforeDate?: string;
    public countryOfOrigin: string;
    public itemExpirationDate?: string;
    public lotNumber: string;
    public packagingDate?: string;
    public productionDate?: string;
    public productQualityIndication: string;
    public sellByDate?: string;
    public serialNumber: string[] = [];
    public shelfLife: string;
    public tradeItemQuantity?: number;
    public itemInContactWithFoodProduct?: boolean;
    public transactionalItemWeight: TransactionalItem[] = [];
    public transactionalItemVolume: TransactionalItem[] = [];
    public serialNumberRange: SerialNumberRange[] = [];
    public transactionalItemDimensions: TransactionalItemDimension[] = [];
    public transactionalItemLogisticUnitInformation: TransactionalItemLogisticUnitInformation;
    public transactionalItemDataCarrierAndIdentification: TransactionalItemDataCarrierAndIdentification;
    public tradeItemWaste: TradeItemWaste[] = [];
    public transactionalItemOrganicInformation: TransactionalItemOrganicInformation;
    public avpList: AvpList[] = [];

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

export class Colour
{
    public colourCode: string;
    public colourDescription: string;

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

export class Size
{
    public descriptiveSize: string;
    public sizeCode: string;

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

export class TradeItemClassification
{
    public gpcCategoryCode: string;
    public additionalTradeItemClassificationCode: AvpList[] = [];
    public gpcCategoryName: string;
    public gpcAttribute: AvpList[] = [];

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

export class TransactionalTradeItem
{
    public gtin: string;
    public additionalTradeItemIdentification: AvpList[] = [];
    public tradeItemQuantity?: number;
    public tradeItemDescription: string;
    public productVariantIdentifier: string;
    public itemTypeCode: string;
    public tradeItemDataOwner: string;
    public butterFatReference: string;
    public transactionalItemData: TransactionalItemData[] = [];
    public colour: Colour[] = [];
    public size: Size;
    public tradeItemClassification: TradeItemClassification;
    public avpList: AvpList[] = [];

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

export class LeviedDutyFeeTax
{
    public dutyFeeTaxAmount?: number;
    public dutyFeeTaxBasisAmount?: number;
    public dutyFeeTaxDescription: string;
    public dutyFeeTaxPercentage?: number;

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

export class OrderLineItemDetail
{
    public requestedQuantity: Quantity;
    public orderLogisticalInformation: OrderLogisticalInformation;
    public avpList: AvpList[] = [];

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

export class OrderLineItem
{
    public freeGoodsQuantity: Quantity;
    public itemPriceBaseQuantity: Quantity;
    public requestedQuantity: Quantity;
    public lineItemActionCode: string;
    public lineItemNumber?: number;
    public listPrice?: number;
    public monetaryAmountExcludingTaxes?: number;
    public monetaryAmountIncludingTaxes?: number;
    public netAmount?: number;
    public netPrice?: number;
    public note: string;
    public orderLineItemInstructionCode: string;
    public parentLineItemNumber?: number;
    public recommendedRetailPrice?: number;
    public orderLineItemPriority: string;
    public additionalOrderLineInstruction: AvpList[] = [];
    public allowanceCharge: AllowanceCharge[] = [];
    public administrativeUnit: AdministrativeUnit[] = [];
    public transactionalTradeItem: TransactionalTradeItem;
    public leviedDutyFeeTax: LeviedDutyFeeTax;
    public contract: DocumentReference;
    public promotionalDeal: DocumentReference;
    public purchaseConditions: DocumentReference;
    public avpList: AvpList[] = [];
    public orderLineItemDetail: OrderLineItemDetail[] = [];

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

export class Order extends BaseDocument
{
    public documentEffectiveDate?: string;
    public additionalOrderInstruction: string;
    public isApplicationReceiptAcknowledgementRequired?: boolean;
    public isOrderFreeOfExciseTaxDuty?: boolean;
    public note: string;
    public orderEntryType: string;
    public orderInstructionCode: string;
    public orderPriority: string;
    public orderTypeCode: string;
    public totalMonetaryAmountExcludingTaxes?: number;
    public totalMonetaryAmountIncludingTaxes?: number;
    public totalTaxAmount?: number;
    public paymentTerms: string;
    public orderIdentification: Ecom_EntityIdentification;
    public orderLogisticalInformation: OrderLogisticalInformation;
    public administrativeUnit: AdministrativeUnit[] = [];
    public deliveryTerms: DeliveryTerms;
    public transactionalGenericReference: AvpList[] = [];
    public referencedOrder: ReferencedOrder[] = [];
    public billTo: TransactionalParty;
    public buyer: TransactionalParty;
    public pickupFrom: TransactionalParty;
    public seller: TransactionalParty;
    public ultimateConsignee: TransactionalParty;
    public contract: DocumentReference;
    public quoteNumber: DocumentReference;
    public promotionalDeal: DocumentReference;
    public tradeAgreement: DocumentReference;
    public deliveryDateAccordingToSchedule?: string;
    public latestDeliveryDate?: string;
    public allowanceCharge: AllowanceCharge[] = [];
    public orderLineItem: OrderLineItem[] = [];

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

export class OrderMessage
{
    public header: Header;
    public order: Order;

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

/** @description Order */
// @Route("/order/{Id}", "GET")
// @Api(Description="Order")
// @ApiResponse(Description="Order data", IsDefaultResponse=true, StatusCode=200)
// @ApiResponse(Description="No Content", ResponseType="typeof(ServiceStack.IReturnVoid)", StatusCode=204)
// @ApiResponse(Description="Specified argument was out of the range of valid values.", ResponseType="typeof(System.ArgumentOutOfRangeException)", StatusCode=400)
export class GetOrderById implements IReturn<OrderMessage>, IGetDocumentById
{
    /** @description Order ID or Token */
    // @ApiMember(Description="Order ID or Token", ExcludeInSchema=true, ParameterType="path")
    public id: string;

    public constructor(init?: Partial<GetOrderById>) { (Object as any).assign(this, init); }
    public getTypeName() { return 'GetOrderById'; }
    public getMethod() { return 'GET'; }
    public createResponse() { return new OrderMessage(); }
}