""" Options:
Date: 2024-12-22 01:13:43
Version: 8.12
Tip: To override a DTO option, remove "#" prefix before updating
BaseUrl: https://taxfiling.pwc.de

#GlobalNamespace: 
#AddServiceStackTypes: True
#AddResponseStatus: False
#AddImplicitVersion: 
#AddDescriptionAsComments: True
IncludeTypes: SearchOrders.*
#ExcludeTypes: 
#DefaultImports: datetime,decimal,marshmallow.fields:*,servicestack:*,typing:*,dataclasses:dataclass/field,dataclasses_json:dataclass_json/LetterCase/Undefined/config,enum:Enum/IntEnum
#DataClass: 
#DataClassJson: 
"""

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


class IPaginate:
    skip: Optional[int] = None
    take: Optional[int] = None


class PeriodMode(str, Enum):
    """
    Represents a specific time interval, within which, an action was carried out.
    """

    TODAY = 'Today'
    YESTERDAY = 'Yesterday'
    LAST_WEEK = 'LastWeek'
    LAST30_DAYS = 'Last30Days'
    LAST90_DAYS = 'Last90Days'
    LAST180_DAYS = 'Last180Days'


# @Api(Description="The number of query results to skip.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PaginationBase(IPaginate):
    """
    The number of query results to skip.
    """

    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """


# @Api(Description="Specifies a service request from a standard user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrdersBase(PaginationBase, IReturn[OrderQueryResponse], IGet):
    """
    Specifies a service request from a standard user to search for orders.
    """

    # @ApiMember(Description="The user name of the account.")
    user_name: Optional[str] = None
    """
    The user name of the account.
    """


    # @ApiMember(Description="The name of the order.")
    name: Optional[str] = None
    """
    The name of the order.
    """


    # @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    service_name: Optional[str] = None
    """
    Search by using the name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
    service_name_starts_with: Optional[str] = None
    """
    Search by using the service name of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
    service_name_ends_with: Optional[str] = None
    """
    Search by using the service name of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
    service_name_contains: Optional[str] = None
    """
    Search by using the service name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    before: Optional[datetime.datetime] = None
    """
    Search for orders placed before a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    after: Optional[datetime.datetime] = None
    """
    Search for orders placed after a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_start_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_end_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    period_mode: Optional[PeriodMode] = None
    """
    Search for orders placed within the last 180 days. Today is included in the search.
    """


    # @ApiMember(Description="Was the order request successful?")
    order_request_succeeded: Optional[bool] = None
    """
    Was the order request successful?
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    unit_of_measurement_starts_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    unit_of_measurement_ends_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    unit_of_measurement_contains: Optional[str] = None
    """
    Search by using the unit of measurement of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    process_type_starts_with: Optional[str] = None
    """
    Search by using the process type of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    process_type_ends_with: Optional[str] = None
    """
    Search by using the process type of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    process_type_contains: Optional[str] = None
    """
    Search by using the process type of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    data_type_starts_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    data_type_ends_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    data_type_contains: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    data_name_starts_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    data_name_ends_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    data_name_contains: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """
    @staticmethod
    def response_type(): return OrderQueryResponse


class HttpStatusCode(IntEnum):
    CONTINUE_ = 100
    SWITCHING_PROTOCOLS = 101
    PROCESSING = 102
    EARLY_HINTS = 103
    OK = 200
    CREATED = 201
    ACCEPTED = 202
    NON_AUTHORITATIVE_INFORMATION = 203
    NO_CONTENT = 204
    RESET_CONTENT = 205
    PARTIAL_CONTENT = 206
    MULTI_STATUS = 207
    ALREADY_REPORTED = 208
    IM_USED = 226
    MULTIPLE_CHOICES = 300
    AMBIGUOUS = 300
    MOVED_PERMANENTLY = 301
    MOVED = 301
    FOUND = 302
    REDIRECT = 302
    SEE_OTHER = 303
    REDIRECT_METHOD = 303
    NOT_MODIFIED = 304
    USE_PROXY = 305
    UNUSED = 306
    TEMPORARY_REDIRECT = 307
    REDIRECT_KEEP_VERB = 307
    PERMANENT_REDIRECT = 308
    BAD_REQUEST = 400
    UNAUTHORIZED = 401
    PAYMENT_REQUIRED = 402
    FORBIDDEN = 403
    NOT_FOUND = 404
    METHOD_NOT_ALLOWED = 405
    NOT_ACCEPTABLE = 406
    PROXY_AUTHENTICATION_REQUIRED = 407
    REQUEST_TIMEOUT = 408
    CONFLICT = 409
    GONE = 410
    LENGTH_REQUIRED = 411
    PRECONDITION_FAILED = 412
    REQUEST_ENTITY_TOO_LARGE = 413
    REQUEST_URI_TOO_LONG = 414
    UNSUPPORTED_MEDIA_TYPE = 415
    REQUESTED_RANGE_NOT_SATISFIABLE = 416
    EXPECTATION_FAILED = 417
    MISDIRECTED_REQUEST = 421
    UNPROCESSABLE_ENTITY = 422
    UNPROCESSABLE_CONTENT = 422
    LOCKED = 423
    FAILED_DEPENDENCY = 424
    UPGRADE_REQUIRED = 426
    PRECONDITION_REQUIRED = 428
    TOO_MANY_REQUESTS = 429
    REQUEST_HEADER_FIELDS_TOO_LARGE = 431
    UNAVAILABLE_FOR_LEGAL_REASONS = 451
    INTERNAL_SERVER_ERROR = 500
    NOT_IMPLEMENTED = 501
    BAD_GATEWAY = 502
    SERVICE_UNAVAILABLE = 503
    GATEWAY_TIMEOUT = 504
    HTTP_VERSION_NOT_SUPPORTED = 505
    VARIANT_ALSO_NEGOTIATES = 506
    INSUFFICIENT_STORAGE = 507
    LOOP_DETECTED = 508
    NOT_EXTENDED = 510
    NETWORK_AUTHENTICATION_REQUIRED = 511


# @Api(Description="Represents a commission to consume services.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order(IHasName):
    """
    Represents a commission to consume services.
    """

    # @ApiMember(Description="The unique identifier of the order.", IsRequired=true)
    id: int = 0
    """
    The unique identifier of the order.
    """


    # @ApiMember(Description="The unique identifier of the product, for which the order is made.", IsRequired=true)
    product_id: int = 0
    """
    The unique identifier of the product, for which the order is made.
    """


    # @ApiMember(Description="The unique identifier of the user account, who placed the order.", IsRequired=true)
    account_id: int = 0
    """
    The unique identifier of the user account, who placed the order.
    """


    # @ApiMember(Description="A name to identify the order.", IsRequired=true)
    # @Validate(Validator="NotEmpty")
    name: Optional[str] = None
    """
    A name to identify the order.
    """


    # @ApiMember(Description="The name of the service, for which the order was made.")
    service_name: Optional[str] = None
    """
    The name of the service, for which the order was made.
    """


    # @ApiMember(Description="The time stamp at which the order was initiated.")
    request_timestamp: Optional[datetime.datetime] = None
    """
    The time stamp at which the order was initiated.
    """


    # @ApiMember(Description="The time stamp at which the order was completed.")
    response_timestamp: Optional[datetime.datetime] = None
    """
    The time stamp at which the order was completed.
    """


    # @ApiMember(Description="The URI from which the order was initiated.")
    request_uri: Optional[str] = None
    """
    The URI from which the order was initiated.
    """


    # @ApiMember(Description="The HTTP method of the order request.")
    request_http_method: Optional[str] = None
    """
    The HTTP method of the order request.
    """


    # @ApiMember(Description="The duration of the order request.")
    request_duration: Optional[datetime.timedelta] = None
    """
    The duration of the order request.
    """


    # @ApiMember(Description="The HTTP status code of the order request.")
    response_status_code: Optional[HttpStatusCode] = None
    """
    The HTTP status code of the order request.
    """


    # @ApiMember(Description="The IP address of client, who placed the order.")
    client_i_p_address: Optional[str] = None
    """
    The IP address of client, who placed the order.
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="The date of creation of the order.")
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date of creation of the order.
    """


    # @ApiMember(Description="The final date to retain the order in the records. After this date, the order is expunged from the records.")
    expiry_date: Optional[datetime.datetime] = None
    """
    The final date to retain the order in the records. After this date, the order is expunged from the records.
    """


    # @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.")
    is_test: bool = False
    """
    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.
    """


class IHasName:
    """
     Specifies that a data type should have a 'Name' property.
    """

    name: Optional[str] = None
    """
    The 'Name' property.
    """


# @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderQueryResponse(QueryResponse[Order]):
    """
    Represents a query response that contains a structured error information and encapsulates customers.
    """

    offset: int = 0
    total: int = 0
    results: Optional[List[Order]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None


# @Route("/sync/orders/search", "GET")
# @Api(Description="Represents a service request from a standard user to search for orders.")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SearchOrders(SearchOrdersBase, IReturn[OrderQueryResponse]):
    """
    Represents a service request from a standard user to search for orders.
    """

    # @ApiMember(Description="The user name of the account.")
    user_name: Optional[str] = None
    """
    The user name of the account.
    """


    # @ApiMember(Description="The name of the order.")
    name: Optional[str] = None
    """
    The name of the order.
    """


    # @ApiMember(Description="Search by using the name of the order that starts with the specified value.")
    name_starts_with: Optional[str] = None
    """
    Search by using the name of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that ends with the specified value.")
    name_ends_with: Optional[str] = None
    """
    Search by using the name of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    name_contains: Optional[str] = None
    """
    Search by using the name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search by using the name of the order that contains the specified value.")
    service_name: Optional[str] = None
    """
    Search by using the name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that starts with the specified value.")
    service_name_starts_with: Optional[str] = None
    """
    Search by using the service name of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that ends with the specified value.")
    service_name_ends_with: Optional[str] = None
    """
    Search by using the service name of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the service name of the order that contains the specified value.")
    service_name_contains: Optional[str] = None
    """
    Search by using the service name of the order that contains the specified value.
    """


    # @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.")
    before: Optional[datetime.datetime] = None
    """
    Search for orders placed before a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed after a certain date and time. The specified date is included in the search.")
    after: Optional[datetime.datetime] = None
    """
    Search for orders placed after a certain date and time. The specified date is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_start_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.")
    period_end_date: Optional[datetime.datetime] = None
    """
    Search for orders placed within a date and time period. The specified date is the start of the period and it is included in the search.
    """


    # @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.")
    period_mode: Optional[PeriodMode] = None
    """
    Search for orders placed within the last 180 days. Today is included in the search.
    """


    # @ApiMember(Description="Was the order request successful?")
    order_request_succeeded: Optional[bool] = None
    """
    Was the order request successful?
    """


    # @ApiMember(Description="The unit of measurement for the order.")
    unit_of_measurement: Optional[str] = None
    """
    The unit of measurement for the order.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that starts with the specified value.")
    unit_of_measurement_starts_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that ends with the specified value.")
    unit_of_measurement_ends_with: Optional[str] = None
    """
    Search by using the unit of measurement of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.")
    unit_of_measurement_contains: Optional[str] = None
    """
    Search by using the unit of measurement of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of process, for which the order is charged.")
    process_type: Optional[str] = None
    """
    The type of process, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the process type of the order that starts with the specified value.")
    process_type_starts_with: Optional[str] = None
    """
    Search by using the process type of the order that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that ends with the specified value.")
    process_type_ends_with: Optional[str] = None
    """
    Search by using the process type of the order that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the process type of the order that contains the specified value.")
    process_type_contains: Optional[str] = None
    """
    Search by using the process type of the order that contains the specified value.
    """


    # @ApiMember(Description="The type of data, for which the order is charged.")
    data_type: Optional[str] = None
    """
    The type of data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that starts with the specified value.")
    data_type_starts_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that ends with the specified value.")
    data_type_ends_with: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.")
    data_type_contains: Optional[str] = None
    """
    Search by using the type of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The name of the data, for which the order is charged.")
    data_name: Optional[str] = None
    """
    The name of the data, for which the order is charged.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that starts with the specified value.")
    data_name_starts_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that starts with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that ends with the specified value.")
    data_name_ends_with: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that ends with the specified value.
    """


    # @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.")
    data_name_contains: Optional[str] = None
    """
    Search by using the name of data, for which the order is charged that contains the specified value.
    """


    # @ApiMember(Description="The number of query results to skip.")
    skip: Optional[int] = None
    """
    The number of query results to skip.
    """


    # @ApiMember(Description="The number of query results to include.")
    take: Optional[int] = None
    """
    The number of query results to include.
    """