""" Options: Date: 2024-12-04 07:59:23 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: RetrieveProductAsync.* #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 # @Api(Description="Specifies a service request to retrieve a product.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class RetrieveProductBase(IReturn[ProductResponse], IGet): """ Specifies a service request to retrieve a product. """ # @ApiMember(Description="The unique identifier of the product.", Name="Id") id: int = 0 """ The unique identifier of the product. """ # @ApiMember(Description="Should the related orders of the account be included in the retrieved product?") include_orders: Optional[bool] = None """ Should the related orders of the account be included in the retrieved product? """ # @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ") skip_orders: Optional[int] = None """ Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. """ # @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ") take_orders: Optional[int] = None """ Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. """ @staticmethod def response_type(): return ProductResponse # @Api(Description="Represents a product.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class Product(IHasName): """ Represents a product. """ # @ApiMember(Description="The unique identifier of the product.", IsRequired=true) id: int = 0 """ The unique identifier of the product. """ # @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true) index: int = 0 """ The position of this instance in a collection of 'Product' instances """ # @ApiMember(Description="The name of the product.", IsRequired=true) # @Validate(Validator="NotEmpty") name: Optional[str] = None """ The name of the product. """ # @ApiMember(Description="The version of the product.", IsRequired=true) # @Validate(Validator="NotEmpty") version: Optional[str] = None """ The version of the product. """ # @ApiMember(Description="The version of the product.") description: Optional[str] = None """ The version of the product. """ # @ApiMember(Description="Tags associated with the product.") tags: Optional[List[str]] = None """ Tags associated with the product. """ 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. """ # @Api(Description="Specifies a base service response class that contains a structured error information.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ServiceResponseBase: """ Specifies a base service response class that contains a structured error information. """ # @ApiMember(Description="Data structure that holds error information from a service operation.") response_status: Optional[ResponseStatus] = None """ Data structure that holds error information from a service operation. """ class IHasName: """ Specifies that a data type should have a 'Name' property. """ name: Optional[str] = None """ The 'Name' property. """ # @Api(Description="Represents a service response that encapsulates product data.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class ProductResponse(ServiceResponseBase): """ Represents a service response that encapsulates product data. """ # @ApiMember(Description="The product data of the response.") product: Optional[Product] = None """ The product data of the response. """ # @ApiMember(Description="The list of orders associated with the encapsulated product.") orders: Optional[List[Order]] = None """ The list of orders associated with the encapsulated product. """ # @ApiMember(Description="Data structure that holds error information from a service operation.") response_status: Optional[ResponseStatus] = None """ Data structure that holds error information from a service operation. """ # @Route("/async/products/{Id}", "GET") # @Api(Description="Represents a service request to retrieve a product in an asynchronous operation.") @dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE) @dataclass class RetrieveProductAsync(RetrieveProductBase, IReturn[ProductResponse]): """ Represents a service request to retrieve a product in an asynchronous operation. """ # @ApiMember(Description="The unique identifier of the product.", Name="Id") id: int = 0 """ The unique identifier of the product. """ # @ApiMember(Description="Should the related orders of the account be included in the retrieved product?") include_orders: Optional[bool] = None """ Should the related orders of the account be included in the retrieved product? """ # @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ") skip_orders: Optional[int] = None """ Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. """ # @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ") take_orders: Optional[int] = None """ Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. """