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

//GlobalNamespace: 
//MakePartial: True
//MakeVirtual: True
//MakeInternal: False
//MakeDataContractsExtensible: False
//AddNullableAnnotations: True
//AddReturnMarker: True
//AddDescriptionAsComments: True
//AddDataContractAttributes: False
//AddIndexesToDataMembers: False
//AddGeneratedCodeAttributes: False
//AddResponseStatus: False
//AddImplicitVersion: 
//InitializeCollections: False
//ExportValueTypes: False
IncludeTypes: GetCreditNoteByType.*
//ExcludeTypes: 
//AddNamespaces: 
//AddDefaultXmlNamespace: http://schemas.servicestack.net/types
*/

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using DX.Framework.Core.Querying;
using DX.STF.Application.ClientApi.Messages.CreditNote;

namespace DX.Framework.Core.Querying
{
    public partial class PagedQueryResult<T>
    {
        public virtual long StartIndex { get; set; }
        public virtual long EndIndex { get; set; }
        public virtual int NumberOfRecordsReturned { get; set; }
        public virtual int TotalNumberOfPages { get; set; }
        public virtual long TotalNumberOfRecords { get; set; }
        public virtual List<ResultItem<OrderMessage>> Results { get; set; } = [];
    }

}

namespace DX.STF.Application.ClientApi.Messages.CreditNote
{
    ///<summary>
    ///Credit Note
    ///</summary>
    [Route("/creditNote/type/{Type}", "GET")]
    [Api(Description="Credit Note")]
    [ApiResponse(Description="Paged credit note response by type", IsDefaultResponse=true, StatusCode=200)]
    public partial class GetCreditNoteByType
        : IReturn<PagedQueryResult<ResultItem<OrderMessage>>>
    {
        ///<summary>
        ///Not used
        ///</summary>
        [ApiMember(Description="Not used")]
        public virtual string SearchTerm { get; set; }

        ///<summary>
        ///Requested page number, starting at 1
        ///</summary>
        [ApiMember(Description="Requested page number, starting at 1")]
        public virtual int RequestedPage { get; set; }

        ///<summary>
        ///Number of records to return on a page
        ///</summary>
        [ApiMember(Description="Number of records to return on a page")]
        public virtual int NumberOfRecordsPerPage { get; set; }

        ///<summary>
        ///Credit Note type to be returned
        ///</summary>
        [ApiMember(Description="Credit Note type to be returned", ExcludeInSchema=true, ParameterType="path")]
        public virtual string Type { get; set; }
    }

}