/* Options:
Date: 2024-11-26 03:26:10
Version: 8.12
Tip: To override a DTO option, remove "//" prefix before updating
BaseUrl: https://taxfiling.staging.pwc.de

//Package: 
//GlobalNamespace: dtos
//AddPropertyAccessors: True
//SettersReturnThis: True
//AddServiceStackTypes: True
//AddResponseStatus: False
//AddDescriptionAsComments: True
//AddImplicitVersion: 
IncludeTypes: RetrieveOrderAsync.*
//ExcludeTypes: 
//TreatTypesAsStrings: 
//DefaultImports: java.math.*,java.util.*,net.servicestack.client.*
*/

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

public class dtos
{

    /**
    * Represents a service request to retrieve an order in an asynchronous operation.
    */
    @Route(Path="/async/orders/{Id}", Verbs="GET")
    @Api(Description="Represents a service request to retrieve an order in an asynchronous operation.")
    public static class RetrieveOrderAsync extends RetrieveOrderBase implements IReturn<OrderResponse>
    {
        /**
        * The unique identifier of the order.
        */
        @ApiMember(Description="The unique identifier of the order.")
        public Integer id = null;
        
        public Integer getId() { return id; }
        public RetrieveOrderAsync setId(Integer value) { this.id = value; return this; }
        private static Object responseType = OrderResponse.class;
        public Object getResponseType() { return responseType; }
    }

    /**
    * Represents a service response that encapsulates an order data.
    */
    @Api(Description="Represents a service response that encapsulates an order data.")
    public static class OrderResponse extends ServiceResponseBase
    {
        /**
        * The order data of the response.
        */
        @ApiMember(Description="The order data of the response.")
        public Order order = null;

        /**
        * Data structure that holds error information from a service operation.
        */
        @ApiMember(Description="Data structure that holds error information from a service operation.")
        public ResponseStatus responseStatus = null;
        
        public Order getOrder() { return order; }
        public OrderResponse setOrder(Order value) { this.order = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public OrderResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    /**
    * Specifies a service request to retrieve an order.
    */
    @Api(Description="Specifies a service request to retrieve an order.")
    public static class RetrieveOrderBase implements IGet
    {
        /**
        * The unique identifier of the order.
        */
        @ApiMember(Description="The unique identifier of the order.")
        public Integer id = null;
        
        public Integer getId() { return id; }
        public RetrieveOrderBase setId(Integer value) { this.id = value; return this; }
    }

    /**
    * Represents a commission to consume services.
    */
    @Api(Description="Represents a commission to consume services.")
    public static class Order implements IHasName
    {
        /**
        * The unique identifier of the order.
        */
        @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
        public Integer id = null;

        /**
        * The unique identifier of the product, for which the order is made.
        */
        @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
        public Integer productId = null;

        /**
        * The unique identifier of the user account, who placed the order.
        */
        @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
        public Integer accountId = null;

        /**
        * A name to identify the order.
        */
        @ApiMember(Description="A name to identify the order.", IsRequired=true)
        @Validate(Validator="NotEmpty")
        public String name = null;

        /**
        * The name of the service, for which the order was made.
        */
        @ApiMember(Description="The name of the service, for which the order was made.")
        public String serviceName = null;

        /**
        * The time stamp at which the order was initiated.
        */
        @ApiMember(Description="The time stamp at which the order was initiated.")
        public Date requestTimestamp = null;

        /**
        * The time stamp at which the order was completed.
        */
        @ApiMember(Description="The time stamp at which the order was completed.")
        public Date responseTimestamp = null;

        /**
        * The URI from which the order was initiated.
        */
        @ApiMember(Description="The URI from which the order was initiated.")
        public String requestUri = null;

        /**
        * The HTTP method of the order request.
        */
        @ApiMember(Description="The HTTP method of the order request.")
        public String requestHttpMethod = null;

        /**
        * The duration of the order request.
        */
        @ApiMember(Description="The duration of the order request.")
        public TimeSpan requestDuration = null;

        /**
        * The HTTP status code of the order request.
        */
        @ApiMember(Description="The HTTP status code of the order request.")
        public HttpStatusCode responseStatusCode = null;

        /**
        * The IP address of client, who placed the order.
        */
        @ApiMember(Description="The IP address of client, who placed the order.")
        public String clientIPAddress = null;

        /**
        * The unit of measurement for the order.
        */
        @ApiMember(Description="The unit of measurement for the order.")
        public String unitOfMeasurement = null;

        /**
        * The type of process, for which the order is charged.
        */
        @ApiMember(Description="The type of process, for which the order is charged.")
        public String processType = null;

        /**
        * The type of data, for which the order is charged.
        */
        @ApiMember(Description="The type of data, for which the order is charged.")
        public String dataType = null;

        /**
        * The name of the data, for which the order is charged.
        */
        @ApiMember(Description="The name of the data, for which the order is charged.")
        public String dataName = null;

        /**
        * The date of creation of the order.
        */
        @ApiMember(Description="The date of creation of the order.")
        public Date creationDate = null;

        /**
        * The final date to retain the order in the records. After this date, the order is expunged from the records.
        */
        @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
        public Date expiryDate = null;

        /**
        * Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.
        */
        @ApiMember(Description="Indicates whether the order is simulated for test purposes. True if the order is simulated for test purposes; otherwise it is a false order for production purposes.")
        public Boolean isTest = null;
        
        public Integer getId() { return id; }
        public Order setId(Integer value) { this.id = value; return this; }
        public Integer getProductId() { return productId; }
        public Order setProductId(Integer value) { this.productId = value; return this; }
        public Integer getAccountId() { return accountId; }
        public Order setAccountId(Integer value) { this.accountId = value; return this; }
        public String getName() { return name; }
        public Order setName(String value) { this.name = value; return this; }
        public String getServiceName() { return serviceName; }
        public Order setServiceName(String value) { this.serviceName = value; return this; }
        public Date getRequestTimestamp() { return requestTimestamp; }
        public Order setRequestTimestamp(Date value) { this.requestTimestamp = value; return this; }
        public Date getResponseTimestamp() { return responseTimestamp; }
        public Order setResponseTimestamp(Date value) { this.responseTimestamp = value; return this; }
        public String getRequestUri() { return requestUri; }
        public Order setRequestUri(String value) { this.requestUri = value; return this; }
        public String getRequestHttpMethod() { return requestHttpMethod; }
        public Order setRequestHttpMethod(String value) { this.requestHttpMethod = value; return this; }
        public TimeSpan getRequestDuration() { return requestDuration; }
        public Order setRequestDuration(TimeSpan value) { this.requestDuration = value; return this; }
        public HttpStatusCode getResponseStatusCode() { return responseStatusCode; }
        public Order setResponseStatusCode(HttpStatusCode value) { this.responseStatusCode = value; return this; }
        public String getClientIPAddress() { return clientIPAddress; }
        public Order setClientIPAddress(String value) { this.clientIPAddress = value; return this; }
        public String getUnitOfMeasurement() { return unitOfMeasurement; }
        public Order setUnitOfMeasurement(String value) { this.unitOfMeasurement = value; return this; }
        public String getProcessType() { return processType; }
        public Order setProcessType(String value) { this.processType = value; return this; }
        public String getDataType() { return dataType; }
        public Order setDataType(String value) { this.dataType = value; return this; }
        public String getDataName() { return dataName; }
        public Order setDataName(String value) { this.dataName = value; return this; }
        public Date getCreationDate() { return creationDate; }
        public Order setCreationDate(Date value) { this.creationDate = value; return this; }
        public Date getExpiryDate() { return expiryDate; }
        public Order setExpiryDate(Date value) { this.expiryDate = value; return this; }
        public Boolean getIsTest() { return isTest; }
        public Order setIsTest(Boolean value) { this.isTest = value; return this; }
    }

    /**
    * Specifies a base service response class that contains a structured error information.
    */
    @Api(Description="Specifies a base service response class that contains a structured error information.")
    public static class ServiceResponseBase
    {
        /**
        * Data structure that holds error information from a service operation.
        */
        @ApiMember(Description="Data structure that holds error information from a service operation.")
        public ResponseStatus responseStatus = null;
        
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ServiceResponseBase setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    /**
    *  Specifies that a data type should have a 'Name' property.
    */
    public static interface IHasName
    {
        /**
        * The 'Name' property.
        */
        public String name = null;
    }

    public static enum HttpStatusCode
    {
        Continue(100),
        SwitchingProtocols(101),
        Processing(102),
        EarlyHints(103),
        Ok(200),
        Created(201),
        Accepted(202),
        NonAuthoritativeInformation(203),
        NoContent(204),
        ResetContent(205),
        PartialContent(206),
        MultiStatus(207),
        AlreadyReported(208),
        ImUsed(226),
        MultipleChoices(300),
        Ambiguous(300),
        MovedPermanently(301),
        Moved(301),
        Found(302),
        Redirect(302),
        SeeOther(303),
        RedirectMethod(303),
        NotModified(304),
        UseProxy(305),
        Unused(306),
        TemporaryRedirect(307),
        RedirectKeepVerb(307),
        PermanentRedirect(308),
        BadRequest(400),
        Unauthorized(401),
        PaymentRequired(402),
        Forbidden(403),
        NotFound(404),
        MethodNotAllowed(405),
        NotAcceptable(406),
        ProxyAuthenticationRequired(407),
        RequestTimeout(408),
        Conflict(409),
        Gone(410),
        LengthRequired(411),
        PreconditionFailed(412),
        RequestEntityTooLarge(413),
        RequestUriTooLong(414),
        UnsupportedMediaType(415),
        RequestedRangeNotSatisfiable(416),
        ExpectationFailed(417),
        MisdirectedRequest(421),
        UnprocessableEntity(422),
        UnprocessableContent(422),
        Locked(423),
        FailedDependency(424),
        UpgradeRequired(426),
        PreconditionRequired(428),
        TooManyRequests(429),
        RequestHeaderFieldsTooLarge(431),
        UnavailableForLegalReasons(451),
        InternalServerError(500),
        NotImplemented(501),
        BadGateway(502),
        ServiceUnavailable(503),
        GatewayTimeout(504),
        HttpVersionNotSupported(505),
        VariantAlsoNegotiates(506),
        InsufficientStorage(507),
        LoopDetected(508),
        NotExtended(510),
        NetworkAuthenticationRequired(511);

        private final int value;
        HttpStatusCode(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

}