/* Options: Date: 2024-12-22 02:25:23 Version: 8.12 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://taxfiling.pwc.de //GlobalNamespace: //MakePropertiesOptional: False //AddServiceStackTypes: True //AddResponseStatus: False //AddImplicitVersion: //AddDescriptionAsComments: True IncludeTypes: SearchOrders.* //ExcludeTypes: //DefaultImports: */ export interface IReturn { createResponse(): T; } export interface IPaginate { skip?: number; take?: number; } /** @description Represents a specific time interval, within which, an action was carried out. */ export enum PeriodMode { Today = 'Today', Yesterday = 'Yesterday', LastWeek = 'LastWeek', Last30Days = 'Last30Days', Last90Days = 'Last90Days', Last180Days = 'Last180Days', } /** @description The number of query results to skip. */ // @Api(Description="The number of query results to skip.") export class PaginationBase implements IPaginate { /** @description The number of query results to skip. */ // @ApiMember(Description="The number of query results to skip.") public skip?: number; /** @description The number of query results to include. */ // @ApiMember(Description="The number of query results to include.") public take?: number; public constructor(init?: Partial) { (Object as any).assign(this, init); } } /** @description Specifies a service request from a standard user to search for orders. */ // @Api(Description="Specifies a service request from a standard user to search for orders.") export class SearchOrdersBase extends PaginationBase implements IGet { /** @description The user name of the account. */ // @ApiMember(Description="The user name of the account.") public userName?: string; /** @description The name of the order. */ // @ApiMember(Description="The name of the order.") public name?: string; /** @description 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 starts with the specified value.") public nameStartsWith?: string; /** @description 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 ends with the specified value.") public nameEndsWith?: string; /** @description 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.") public nameContains?: string; /** @description 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.") public serviceName?: string; /** @description 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 starts with the specified value.") public serviceNameStartsWith?: string; /** @description 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 ends with the specified value.") public serviceNameEndsWith?: string; /** @description Search by using the service name of the order that contains the specified value. */ // @ApiMember(Description="Search by using the service name of the order that contains the specified value.") public serviceNameContains?: string; /** @description Search for orders placed before a certain date and time. The specified date is included in the search. */ // @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.") public before?: string; /** @description Search for orders placed after 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.") public after?: string; /** @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. */ // @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.") public periodStartDate?: string; /** @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. */ // @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.") public periodEndDate?: string; /** @description Search for orders placed within the last 180 days. Today is included in the search. */ // @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.") public periodMode?: PeriodMode; /** @description Was the order request successful? */ // @ApiMember(Description="Was the order request successful?") public orderRequestSucceeded?: boolean; /** @description The unit of measurement for the order. */ // @ApiMember(Description="The unit of measurement for the order.") public unitOfMeasurement?: string; /** @description 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 starts with the specified value.") public unitOfMeasurementStartsWith?: string; /** @description 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 ends with the specified value.") public unitOfMeasurementEndsWith?: string; /** @description Search by using the unit of measurement of the order that contains the specified value. */ // @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.") public unitOfMeasurementContains?: string; /** @description The type of process, for which the order is charged. */ // @ApiMember(Description="The type of process, for which the order is charged.") public processType?: string; /** @description 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 starts with the specified value.") public processTypeStartsWith?: string; /** @description 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 ends with the specified value.") public processTypeEndsWith?: string; /** @description Search by using the process type of the order that contains the specified value. */ // @ApiMember(Description="Search by using the process type of the order that contains the specified value.") public processTypeContains?: string; /** @description The type of data, for which the order is charged. */ // @ApiMember(Description="The type of data, for which the order is charged.") public dataType?: string; /** @description 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 starts with the specified value.") public dataTypeStartsWith?: string; /** @description 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 ends with the specified value.") public dataTypeEndsWith?: string; /** @description Search by using the type of data, for which the order is charged that contains the specified value. */ // @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.") public dataTypeContains?: string; /** @description 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 dataName?: string; /** @description 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 starts with the specified value.") public dataNameStartsWith?: string; /** @description 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 ends with the specified value.") public dataNameEndsWith?: string; /** @description Search by using the name of data, for which the order is charged that contains the specified value. */ // @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.") public dataNameContains?: string; /** @description The number of query results to skip. */ // @ApiMember(Description="The number of query results to skip.") public skip?: number; /** @description The number of query results to include. */ // @ApiMember(Description="The number of query results to include.") public take?: number; public constructor(init?: Partial) { super(init); (Object as any).assign(this, init); } } // @DataContract export class ResponseError { // @DataMember(Order=1) public errorCode: string; // @DataMember(Order=2) public fieldName: string; // @DataMember(Order=3) public message: string; // @DataMember(Order=4) public meta: { [index: string]: string; }; public constructor(init?: Partial) { (Object as any).assign(this, init); } } // @DataContract export class ResponseStatus { // @DataMember(Order=1) public errorCode: string; // @DataMember(Order=2) public message: string; // @DataMember(Order=3) public stackTrace: string; // @DataMember(Order=4) public errors: ResponseError[]; // @DataMember(Order=5) public meta: { [index: string]: string; }; public constructor(init?: Partial) { (Object as any).assign(this, init); } } export 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, } /** @description Represents a commission to consume services. */ // @Api(Description="Represents a commission to consume services.") export class Order implements IHasName { /** @description The unique identifier of the order. */ // @ApiMember(Description="The unique identifier of the order.", IsRequired=true) public id: number; /** @description 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 productId: number; /** @description 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 accountId: number; /** @description A name to identify the order. */ // @ApiMember(Description="A name to identify the order.", IsRequired=true) // @Validate(Validator="NotEmpty") public name: string; /** @description 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 serviceName?: string; /** @description The time stamp at which the order was initiated. */ // @ApiMember(Description="The time stamp at which the order was initiated.") public requestTimestamp?: string; /** @description The time stamp at which the order was completed. */ // @ApiMember(Description="The time stamp at which the order was completed.") public responseTimestamp?: string; /** @description The URI from which the order was initiated. */ // @ApiMember(Description="The URI from which the order was initiated.") public requestUri?: string; /** @description The HTTP method of the order request. */ // @ApiMember(Description="The HTTP method of the order request.") public requestHttpMethod?: string; /** @description The duration of the order request. */ // @ApiMember(Description="The duration of the order request.") public requestDuration?: string; /** @description The HTTP status code of the order request. */ // @ApiMember(Description="The HTTP status code of the order request.") public responseStatusCode: HttpStatusCode; /** @description The IP address of client, who placed the order. */ // @ApiMember(Description="The IP address of client, who placed the order.") public clientIPAddress?: string; /** @description The unit of measurement for the order. */ // @ApiMember(Description="The unit of measurement for the order.") public unitOfMeasurement?: string; /** @description The type of process, for which the order is charged. */ // @ApiMember(Description="The type of process, for which the order is charged.") public processType?: string; /** @description The type of data, for which the order is charged. */ // @ApiMember(Description="The type of data, for which the order is charged.") public dataType?: string; /** @description 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 dataName?: string; /** @description The date of creation of the order. */ // @ApiMember(Description="The date of creation of the order.") public creationDate: string; /** @description 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 expiryDate?: string; /** @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. */ // @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 isTest: boolean; public constructor(init?: Partial) { (Object as any).assign(this, init); } } // @DataContract export class QueryResponse { // @DataMember(Order=1) public offset: number; // @DataMember(Order=2) public total: number; // @DataMember(Order=3) public results: T[]; // @DataMember(Order=4) public meta: { [index: string]: string; }; // @DataMember(Order=5) public responseStatus: ResponseStatus; public constructor(init?: Partial>) { (Object as any).assign(this, init); } } /** @description Specifies that a data type should have a 'Name' property. */ export interface IHasName { /** @description The 'Name' property. */ name?: string; } /** @description Represents a query response that contains a structured error information and encapsulates customers. */ // @Api(Description="Represents a query response that contains a structured error information and encapsulates customers.") export class OrderQueryResponse extends QueryResponse { // @DataMember(Order=1) public offset: number; // @DataMember(Order=2) public total: number; // @DataMember(Order=3) public results: Order[]; // @DataMember(Order=4) public meta: { [index: string]: string; }; // @DataMember(Order=5) public responseStatus: ResponseStatus; public constructor(init?: Partial) { super(init); (Object as any).assign(this, init); } } /** @description Represents a service request from a standard user to search for orders. */ // @Route("/sync/orders/search", "GET") // @Api(Description="Represents a service request from a standard user to search for orders.") export class SearchOrders extends SearchOrdersBase implements IReturn { /** @description The user name of the account. */ // @ApiMember(Description="The user name of the account.") public userName?: string; /** @description The name of the order. */ // @ApiMember(Description="The name of the order.") public name?: string; /** @description 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 starts with the specified value.") public nameStartsWith?: string; /** @description 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 ends with the specified value.") public nameEndsWith?: string; /** @description 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.") public nameContains?: string; /** @description 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.") public serviceName?: string; /** @description 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 starts with the specified value.") public serviceNameStartsWith?: string; /** @description 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 ends with the specified value.") public serviceNameEndsWith?: string; /** @description Search by using the service name of the order that contains the specified value. */ // @ApiMember(Description="Search by using the service name of the order that contains the specified value.") public serviceNameContains?: string; /** @description Search for orders placed before a certain date and time. The specified date is included in the search. */ // @ApiMember(Description="Search for orders placed before a certain date and time. The specified date is included in the search.") public before?: string; /** @description Search for orders placed after 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.") public after?: string; /** @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. */ // @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.") public periodStartDate?: string; /** @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. */ // @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.") public periodEndDate?: string; /** @description Search for orders placed within the last 180 days. Today is included in the search. */ // @ApiMember(Description="Search for orders placed within the last 180 days. Today is included in the search.") public periodMode?: PeriodMode; /** @description Was the order request successful? */ // @ApiMember(Description="Was the order request successful?") public orderRequestSucceeded?: boolean; /** @description The unit of measurement for the order. */ // @ApiMember(Description="The unit of measurement for the order.") public unitOfMeasurement?: string; /** @description 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 starts with the specified value.") public unitOfMeasurementStartsWith?: string; /** @description 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 ends with the specified value.") public unitOfMeasurementEndsWith?: string; /** @description Search by using the unit of measurement of the order that contains the specified value. */ // @ApiMember(Description="Search by using the unit of measurement of the order that contains the specified value.") public unitOfMeasurementContains?: string; /** @description The type of process, for which the order is charged. */ // @ApiMember(Description="The type of process, for which the order is charged.") public processType?: string; /** @description 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 starts with the specified value.") public processTypeStartsWith?: string; /** @description 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 ends with the specified value.") public processTypeEndsWith?: string; /** @description Search by using the process type of the order that contains the specified value. */ // @ApiMember(Description="Search by using the process type of the order that contains the specified value.") public processTypeContains?: string; /** @description The type of data, for which the order is charged. */ // @ApiMember(Description="The type of data, for which the order is charged.") public dataType?: string; /** @description 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 starts with the specified value.") public dataTypeStartsWith?: string; /** @description 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 ends with the specified value.") public dataTypeEndsWith?: string; /** @description Search by using the type of data, for which the order is charged that contains the specified value. */ // @ApiMember(Description="Search by using the type of data, for which the order is charged that contains the specified value.") public dataTypeContains?: string; /** @description 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 dataName?: string; /** @description 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 starts with the specified value.") public dataNameStartsWith?: string; /** @description 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 ends with the specified value.") public dataNameEndsWith?: string; /** @description Search by using the name of data, for which the order is charged that contains the specified value. */ // @ApiMember(Description="Search by using the name of data, for which the order is charged that contains the specified value.") public dataNameContains?: string; /** @description The number of query results to skip. */ // @ApiMember(Description="The number of query results to skip.") public skip?: number; /** @description The number of query results to include. */ // @ApiMember(Description="The number of query results to include.") public take?: number; public constructor(init?: Partial) { super(init); (Object as any).assign(this, init); } public getTypeName() { return 'SearchOrders'; } public getMethod() { return 'GET'; } public createResponse() { return new OrderQueryResponse(); } }