/* Options: Date: 2024-11-29 14:52:31 Version: 8.12 Tip: To override a DTO option, remove "//" prefix before updating BaseUrl: https://taxfiling.staging.pwc.de //GlobalNamespace: //MakePropertiesOptional: False //AddServiceStackTypes: True //AddResponseStatus: False //AddImplicitVersion: //AddDescriptionAsComments: True IncludeTypes: AdminRetrieveAccountAsync.* //ExcludeTypes: //DefaultImports: */ export interface IReturn { createResponse(): T; } /** @description Specifies a service request from an admin user to retrieve an account. */ // @Api(Description="Specifies a service request from an admin user to retrieve an account.") export class AdminRetrieveAccountBase implements IGet { /** @description The unique identifier of the account. */ // @ApiMember(Description="The unique identifier of the account.") public id?: number; /** @description The user name of the account. */ // @ApiMember(Description="The user name of the account.") public userName?: string; /** @description Should the related products of the account be included in the retrieved account? */ // @ApiMember(Description="Should the related products of the account be included in the retrieved account?") public includeProducts?: boolean; /** @description Should the related orders of the account be included in the retrieved account? */ // @ApiMember(Description="Should the related orders of the account be included in the retrieved account?") public includeOrders?: boolean; /** @description Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. */ // @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ") public skipProducts?: number; /** @description Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. */ // @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ") public takeProducts?: number; /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. */ // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ") public skipOrders?: number; /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. */ // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ") public takeOrders?: number; public constructor(init?: Partial) { (Object as any).assign(this, init); } } /** @description Represents a user account. */ // @Api(Description="Represents a user account.") export class Account implements IHasUserName { /** @description The unique identifier of the user account. */ // @ApiMember(Description="The unique identifier of the user account.", IsRequired=true) public id: number; /** @description The position of this instance in a collection of 'Account' instances */ // @ApiMember(Description="The position of this instance in a collection of 'Account' instances", IsRequired=true) public index: number; /** @description The unique identifier of the customer associated with this account. */ // @ApiMember(Description="The unique identifier of the customer associated with this account.", IsRequired=true) public refId: number; /** @description The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'. */ // @ApiMember(Description="The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.") public refIdStr?: string; /** @description The unique user name of the user account. */ // @ApiMember(Description="The unique user name of the user account.", IsRequired=true) public userName: string; /** @description The electronic mail address of the user account. */ // @ApiMember(Description="The electronic mail address of the user account.") public email?: string; /** @description The friendly name of the user account. */ // @ApiMember(Description="The friendly name of the user account.") public displayName?: string; /** @description The first name of the owner (natural person) of the user account. */ // @ApiMember(Description="The first name of the owner (natural person) of the user account.") public firstName?: string; /** @description The last name of the owner (natural person) of the user account. */ // @ApiMember(Description="The last name of the owner (natural person) of the user account.") public lastName?: string; /** @description The unique identifier of the customer associated with this account. */ // @ApiMember(Description="The unique identifier of the customer associated with this account.") public fullName?: string; /** @description The gender of the owner (natural person) of the user account. */ // @ApiMember(Description="The gender of the owner (natural person) of the user account.") public gender?: string; /** @description The language of the owner of teh user account. */ // @ApiMember(Description="The language of the owner of teh user account.") public language?: string; /** @description The company, where the user is an employee. */ // @ApiMember(Description="The company, where the user is an employee.") public company?: string; /** @description The profile URL of the user account. */ // @ApiMember(Description="The profile URL of the user account.", IsRequired=true) public profileUrl: string; /** @description The roles assigned to the user account. */ // @ApiMember(Description="The roles assigned to the user account.") public roles: string[]; /** @description The permissions assigned to the user account. */ // @ApiMember(Description="The permissions assigned to the user account.") public permissions: string[]; /** @description The primary e-mail address of the user. */ // @ApiMember(Description="The primary e-mail address of the user.") public primaryEmail?: string; /** @description Random data to enhance the security of the user password. */ // @ApiMember(Description="Random data to enhance the security of the user password.") public salt?: string; /** @description The hash value of the user password that the PBKDF2 algorithm produces. */ // @ApiMember(Description="The hash value of the user password that the PBKDF2 algorithm produces.") public passwordHash?: string; /** @description The hash value of the user password that the DigestHa1 algorithm produces. */ // @ApiMember(Description="The hash value of the user password that the DigestHa1 algorithm produces.") public digestHa1Hash?: string; /** @description The number of times the user account tried to sign in but failed. */ // @ApiMember(Description="The number of times the user account tried to sign in but failed.") public invalidLoginAttempts: number; /** @description The last time the user account attempted a sign in. */ // @ApiMember(Description="The last time the user account attempted a sign in.") public lastLoginAttempt?: string; /** @description The date and time when the user acount was denied access. */ // @ApiMember(Description="The date and time when the user acount was denied access.") public lockedDate?: string; /** @description The date and time when the user account was created. */ // @ApiMember(Description="The date and time when the user account was created.") public createdDate: string; /** @description The date and time when the user account was last modified. */ // @ApiMember(Description="The date and time when the user account was last modified.") public modifiedDate: string; /** @description The telephone number of the owner of the user account. */ // @ApiMember(Description="The telephone number of the owner of the user account.") public phoneNumber?: string; /** @description The birth date of the owner of the user account */ // @ApiMember(Description="The birth date of the owner of the user account") public birthDate?: string; /** @description The string representation of the birth date of the user account. */ // @ApiMember(Description="The string representation of the birth date of the user account.") public birthDateRaw?: string; /** @description The mail address of the user account. */ // @ApiMember(Description="The mail address of the user account.") public address?: string; /** @description Additional information for the specified 'Address' of the user. */ // @ApiMember(Description="Additional information for the specified 'Address' of the user.") public address2?: string; /** @description The city of the owner of the user account. */ // @ApiMember(Description="The city of the owner of the user account.") public city?: string; /** @description The state of the owner of the user account. */ // @ApiMember(Description="The state of the owner of the user account.") public state?: string; /** @description The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'. */ // @ApiMember(Description="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.") public country?: string; /** @description The locale of the user account. */ // @ApiMember(Description="The locale of the user account.") public culture?: string; /** @description The mail address of the user account. */ // @ApiMember(Description="The mail address of the user account.") public mailAddress?: string; /** @description The nickname of the user of the user account. */ // @ApiMember(Description="The nickname of the user of the user account.") public nickname?: string; /** @description The postal code of the user account. */ // @ApiMember(Description="The postal code of the user account.") public postalCode?: string; /** @description The time zone of the user of the user account. */ // @ApiMember(Description="The time zone of the user of the user account.") public timeZone?: string; /** @description Additional information to attach to the user account. */ // @ApiMember(Description="Additional information to attach to the user account.") public meta?: { [index: string]: string; }; public constructor(init?: Partial) { (Object as any).assign(this, init); } } /** @description Represents a product. */ // @Api(Description="Represents a product.") export class Product implements IHasName { /** @description The unique identifier of the product. */ // @ApiMember(Description="The unique identifier of the product.", IsRequired=true) public id: number; /** @description The position of this instance in a collection of 'Product' instances */ // @ApiMember(Description="The position of this instance in a collection of 'Product' instances", IsRequired=true) public index: number; /** @description The name of the product. */ // @ApiMember(Description="The name of the product.", IsRequired=true) // @Validate(Validator="NotEmpty") public name: string; /** @description The version of the product. */ // @ApiMember(Description="The version of the product.", IsRequired=true) // @Validate(Validator="NotEmpty") public version: string; /** @description The version of the product. */ // @ApiMember(Description="The version of the product.") public description?: string; /** @description Tags associated with the product. */ // @ApiMember(Description="Tags associated with the product.") public tags: string[]; public constructor(init?: Partial) { (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); } } /** @description 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.") export class ServiceResponseBase { /** @description 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; public constructor(init?: Partial) { (Object as any).assign(this, init); } } /** @description Specifies that a data type should have a 'UserName' property. */ export interface IHasUserName { userName?: string; } /** @description Specifies that a data type should have a 'Name' property. */ export interface IHasName { /** @description The 'Name' property. */ name?: string; } /** @description Represents a service response that contains a structured error information and encapsulates a user account. */ // @Api(Description="Represents a service response that contains a structured error information and encapsulates a user account.") export class AccountResponse extends ServiceResponseBase { /** @description The user account encapsulated in the response. */ // @ApiMember(Description="The user account encapsulated in the response.") public account?: Account; /** @description The index position of the reponse in a collection, if it were returned together with other responses. */ // @ApiMember(Description="The index position of the reponse in a collection, if it were returned together with other responses.") public index: number; /** @description The list of products associated with the encapsulated user account. */ // @ApiMember(Description="The list of products associated with the encapsulated user account.") public products: Product[]; /** @description The list of orders associated with the encapsulated user account. */ // @ApiMember(Description="The list of orders associated with the encapsulated user account.") public orders: Order[]; /** @description 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; public constructor(init?: Partial) { super(init); (Object as any).assign(this, init); } } /** @description RRepresents a service request from an admin user to retrieve an account in an asynchronous operation. */ // @Route("/async/accounts/{Id}", "GET") // @Api(Description="RRepresents a service request from an admin user to retrieve an account in an asynchronous operation.") export class AdminRetrieveAccountAsync extends AdminRetrieveAccountBase implements IReturn { /** @description The unique identifier of the account. */ // @ApiMember(Description="The unique identifier of the account.") public id?: number; /** @description The user name of the account. */ // @ApiMember(Description="The user name of the account.") public userName?: string; /** @description Should the related products of the account be included in the retrieved account? */ // @ApiMember(Description="Should the related products of the account be included in the retrieved account?") public includeProducts?: boolean; /** @description Should the related orders of the account be included in the retrieved account? */ // @ApiMember(Description="Should the related orders of the account be included in the retrieved account?") public includeOrders?: boolean; /** @description Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. */ // @ApiMember(Description="Specifies the number of products to skip. Applicable only when 'IncludeProducts' is true. ") public skipProducts?: number; /** @description Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. */ // @ApiMember(Description="Specifies the number of products to include. Applicable only when 'IncludeProducts' is true. ") public takeProducts?: number; /** @description Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. */ // @ApiMember(Description="Specifies the number of orders to skip. Applicable only when 'IncludeOrders' is true. ") public skipOrders?: number; /** @description Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. */ // @ApiMember(Description="Specifies the number of orders to include. Applicable only when 'IncludeOrders' is true. ") public takeOrders?: number; public constructor(init?: Partial) { super(init); (Object as any).assign(this, init); } public getTypeName() { return 'AdminRetrieveAccountAsync'; } public getMethod() { return 'GET'; } public createResponse() { return new AccountResponse(); } }