' Options:
'Date: 2025-04-06 16:19:47
'Version: 8.52
'Tip: To override a DTO option, remove "''" prefix before updating
'BaseUrl: https://taxfiling.pwc.de
'
'''GlobalNamespace: 
'''MakePartial: True
'''MakeVirtual: True
'''MakeDataContractsExtensible: False
'''AddReturnMarker: True
'''AddDescriptionAsComments: True
'''AddDataContractAttributes: False
'''AddIndexesToDataMembers: False
'''AddGeneratedCodeAttributes: False
'''AddResponseStatus: False
'''AddImplicitVersion: 
'''InitializeCollections: False
'''ExportValueTypes: False
'IncludeTypes: RetrieveAllCustomers.*
'''ExcludeTypes: 
'''AddNamespaces: 
'''AddDefaultXmlNamespace: http://schemas.servicestack.net/types

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports System.Net
Imports PwC.Metering.Core.Services.Contracts.Helpers
Imports PwC.Metering.Core.Domain.Concretes.Models
Imports PwC.Metering.Core.Services.Contracts.Requests
Imports PwC.Metering.Core.Domain.Concretes.Interfaces
Imports PwC.Metering.Core.Services.Contracts.Responses

Namespace Global

    Namespace PwC.Metering.Core.Domain.Concretes.Interfaces

        '''<Summary>
        ''' Specifies that a data type should have a 'Name' property.
        '''</Summary>
        Public Interface IHasName
            '''<Summary>
            '''The 'Name' property.
            '''</Summary>
            Property Name As String
        End Interface

        '''<Summary>
        ''' Specifies that a data type should have a 'UserName' property.
        '''</Summary>
        Public Interface IHasUserName
            Property UserName As String
        End Interface
    End Namespace

    Namespace PwC.Metering.Core.Domain.Concretes.Models

        '''<Summary>
        '''Represents a user account.
        '''</Summary>
        <Api(Description:="Represents a user account.")>
        Public Partial Class Account
            Implements IHasUserName
            '''<Summary>
            '''The unique identifier of the user account.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the user account.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The position of this instance in a collection of 'Account' instances
            '''</Summary>
            <ApiMember(Description:="The position of this instance in a collection of 'Account' instances", IsRequired:=true)>
            Public Overridable Property Index As Integer

            '''<Summary>
            '''The unique identifier of the customer associated with this account.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the customer associated with this account.", IsRequired:=true)>
            Public Overridable Property RefId As Integer?

            '''<Summary>
            '''The string representation of the unique identifier of a reference that associates with this user account. This should have the same value as 'RefId'.
            '''</Summary>
            <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 Overridable Property RefIdStr As String

            '''<Summary>
            '''The unique user name of the user account.
            '''</Summary>
            <ApiMember(Description:="The unique user name of the user account.", IsRequired:=true)>
            Public Overridable Property UserName As String Implements IHasUserName.UserName

            '''<Summary>
            '''The electronic mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The electronic mail address of the user account.")>
            Public Overridable Property Email As String

            '''<Summary>
            '''The friendly name of the user account.
            '''</Summary>
            <ApiMember(Description:="The friendly name of the user account.")>
            Public Overridable Property DisplayName As String

            '''<Summary>
            '''The first name of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The first name of the owner (natural person) of the user account.")>
            Public Overridable Property FirstName As String

            '''<Summary>
            '''The last name of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The last name of the owner (natural person) of the user account.")>
            Public Overridable Property LastName As String

            '''<Summary>
            '''The unique identifier of the customer associated with this account.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the customer associated with this account.")>
            Public Overridable Property FullName As String

            '''<Summary>
            '''The gender of the owner (natural person) of the user account.
            '''</Summary>
            <ApiMember(Description:="The gender of the owner (natural person) of the user account.")>
            Public Overridable Property Gender As String

            '''<Summary>
            '''The language of the owner of teh user account.
            '''</Summary>
            <ApiMember(Description:="The language of the owner of teh user account.")>
            Public Overridable Property Language As String

            '''<Summary>
            '''The company, where the user is an employee.
            '''</Summary>
            <ApiMember(Description:="The company, where the user is an employee.")>
            Public Overridable Property Company As String

            '''<Summary>
            '''The profile URL of the user account.
            '''</Summary>
            <ApiMember(Description:="The profile URL of the user account.", IsRequired:=true)>
            Public Overridable Property ProfileUrl As String

            '''<Summary>
            '''The roles assigned to the user account.
            '''</Summary>
            <ApiMember(Description:="The roles assigned to the user account.")>
            Public Overridable Property Roles As List(Of String) = New List(Of String)

            '''<Summary>
            '''The permissions assigned to the user account.
            '''</Summary>
            <ApiMember(Description:="The permissions assigned to the user account.")>
            Public Overridable Property Permissions As List(Of String) = New List(Of String)

            '''<Summary>
            '''The primary e-mail address of the user.
            '''</Summary>
            <ApiMember(Description:="The primary e-mail address of the user.")>
            Public Overridable Property PrimaryEmail As String

            '''<Summary>
            '''Random data to enhance the security of the user password.
            '''</Summary>
            <ApiMember(Description:="Random data to enhance the security of the user password.")>
            Public Overridable Property Salt As String

            '''<Summary>
            '''The hash value of the user password that the PBKDF2 algorithm produces.
            '''</Summary>
            <ApiMember(Description:="The hash value of the user password that the PBKDF2 algorithm produces.")>
            Public Overridable Property PasswordHash As String

            '''<Summary>
            '''The hash value of the user password that the DigestHa1 algorithm produces.
            '''</Summary>
            <ApiMember(Description:="The hash value of the user password that the DigestHa1 algorithm produces.")>
            Public Overridable Property DigestHa1Hash As String

            '''<Summary>
            '''The number of times the user account tried to sign in but failed.
            '''</Summary>
            <ApiMember(Description:="The number of times the user account tried to sign in but failed.")>
            Public Overridable Property InvalidLoginAttempts As Integer

            '''<Summary>
            '''The last time the user account attempted a sign in.
            '''</Summary>
            <ApiMember(Description:="The last time the user account attempted a sign in.")>
            Public Overridable Property LastLoginAttempt As Date?

            '''<Summary>
            '''The date and time when the user acount was denied access.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user acount was denied access.")>
            Public Overridable Property LockedDate As Date?

            '''<Summary>
            '''The date and time when the user account was created.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user account was created.")>
            Public Overridable Property CreatedDate As Date

            '''<Summary>
            '''The date and time when the user account was last modified.
            '''</Summary>
            <ApiMember(Description:="The date and time when the user account was last modified.")>
            Public Overridable Property ModifiedDate As Date

            '''<Summary>
            '''The telephone number of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The telephone number of the owner of the user account.")>
            Public Overridable Property PhoneNumber As String

            '''<Summary>
            '''The birth date of the owner of the user account
            '''</Summary>
            <ApiMember(Description:="The birth date of the owner of the user account")>
            Public Overridable Property BirthDate As Date?

            '''<Summary>
            '''The string representation of the birth date of the user account.
            '''</Summary>
            <ApiMember(Description:="The string representation of the birth date of the user account.")>
            Public Overridable Property BirthDateRaw As String

            '''<Summary>
            '''The mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The mail address of the user account.")>
            Public Overridable Property Address As String

            '''<Summary>
            '''Additional information for the specified 'Address' of the user.
            '''</Summary>
            <ApiMember(Description:="Additional information for the specified 'Address' of the user.")>
            Public Overridable Property Address2 As String

            '''<Summary>
            '''The city of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The city of the owner of the user account.")>
            Public Overridable Property City As String

            '''<Summary>
            '''The state of the owner of the user account.
            '''</Summary>
            <ApiMember(Description:="The state of the owner of the user account.")>
            Public Overridable Property State As String

            '''<Summary>
            '''The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.
            '''</Summary>
            <ApiMember(Description:="The country of the owner of the user account. It is recommended to use the name of the associated 'Customer'.")>
            Public Overridable Property Country As String

            '''<Summary>
            '''The locale of the user account.
            '''</Summary>
            <ApiMember(Description:="The locale of the user account.")>
            Public Overridable Property Culture As String

            '''<Summary>
            '''The mail address of the user account.
            '''</Summary>
            <ApiMember(Description:="The mail address of the user account.")>
            Public Overridable Property MailAddress As String

            '''<Summary>
            '''The nickname of the user of the user account.
            '''</Summary>
            <ApiMember(Description:="The nickname of the user of the user account.")>
            Public Overridable Property Nickname As String

            '''<Summary>
            '''The postal code of the user account.
            '''</Summary>
            <ApiMember(Description:="The postal code of the user account.")>
            Public Overridable Property PostalCode As String

            '''<Summary>
            '''The time zone of the user of the user account.
            '''</Summary>
            <ApiMember(Description:="The time zone of the user of the user account.")>
            Public Overridable Property TimeZone As String

            '''<Summary>
            '''Additional information to attach to the user account.
            '''</Summary>
            <ApiMember(Description:="Additional information to attach to the user account.")>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        '''<Summary>
        '''Represents a customer (business organization or entrepreneur).
        '''</Summary>
        <Api(Description:="Represents a customer (business organization or entrepreneur).")>
        Public Partial Class Customer
            Implements IHasName
            '''<Summary>
            '''The unique identifier of the customer.
            '''</Summary>
            <ApiMember(Description:="The unique identifier of the customer.", IsRequired:=true)>
            Public Overridable Property Id As Integer

            '''<Summary>
            '''The position of this instance in a collection of 'Customer' instances
            '''</Summary>
            <ApiMember(Description:="The position of this instance in a collection of 'Customer' instances", IsRequired:=true)>
            Public Overridable Property Index As Integer

            '''<Summary>
            '''Full name or organization name of customer.
            '''</Summary>
            <ApiMember(Description:="Full name or organization name of customer.", IsRequired:=true)>
            <Validate(Validator:="NotEmpty")>
            Public Overridable Property Name As String Implements IHasName.Name

            '''<Summary>
            '''The country of residence or business of customer.
            '''</Summary>
            <ApiMember(Description:="The country of residence or business of customer.")>
            Public Overridable Property Country As String

            '''<Summary>
            '''The type of customer.
            '''</Summary>
            <ApiMember(Description:="The type of customer.")>
            Public Overridable Property Type As CustomerType

            '''<Summary>
            '''The list of user accounts associated with this customer.
            '''</Summary>
            <ApiMember(Description:="The list of user accounts associated with this customer.")>
            <Ignore>
            Public Overridable Property Accounts As List(Of Account) = New List(Of Account)
        End Class

        Public Enum CustomerType
            Internal
            Network
            External
        End Enum
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Helpers

        Public Interface IPaginate
            Property Skip As Integer?
            Property Take As Integer?
        End Interface

        '''<Summary>
        '''The number of query results to skip.
        '''</Summary>
        <Api(Description:="The number of query results to skip.")>
        Public Partial Class PaginationBase
            Implements IPaginate
            '''<Summary>
            '''The number of query results to skip.
            '''</Summary>
            <ApiMember(Description:="The number of query results to skip.")>
            Public Overridable Property Skip As Integer? Implements IPaginate.Skip

            '''<Summary>
            '''The number of query results to include.
            '''</Summary>
            <ApiMember(Description:="The number of query results to include.")>
            Public Overridable Property Take As Integer? Implements IPaginate.Take
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Requests

        '''<Summary>
        '''Represents a service request to retrieve all customers.
        '''</Summary>
        <Route("/sync/customers", "GET")>
        <Api(Description:="Represents a service request to retrieve all customers.")>
        Public Partial Class RetrieveAllCustomers
            Inherits RetrieveAllCustomersBase
            Implements IReturn(Of CustomerQueryResponse)
        End Class

        '''<Summary>
        '''Specifies a service to search for customers.
        '''</Summary>
        <Api(Description:="Specifies a service to search for customers.")>
        Public Partial Class RetrieveAllCustomersBase
            Inherits PaginationBase
            Implements IGet
            '''<Summary>
            '''Should related accounts be included in the retrieved customers?
            '''</Summary>
            <ApiMember(Description:="Should related accounts be included in the retrieved customers?")>
            Public Overridable Property IncludeAccounts As Boolean?

            '''<Summary>
            '''Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to skip per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property SkipAccounts As Integer?

            '''<Summary>
            '''Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. 
            '''</Summary>
            <ApiMember(Description:="Specifies the number of products to include per customer. Applicable only when 'IncludeAccounts' is true. ")>
            Public Overridable Property TakeAccounts As Integer?
        End Class
    End Namespace

    Namespace PwC.Metering.Core.Services.Contracts.Responses

        '''<Summary>
        '''Represents a query response that contains a structured error information and encapsulates customers.
        '''</Summary>
        <Api(Description:="Represents a query response that contains a structured error information and encapsulates customers.")>
        Public Partial Class CustomerQueryResponse
            Inherits QueryResponse(Of Customer)
        End Class
    End Namespace
End Namespace