AuthDtos.cs

// Copyright (c) ServiceStack, Inc. All Rights Reserved.
// License: https://raw.github.com/ServiceStack/ServiceStack/master/license.txt

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack.DataAnnotations;

namespace ServiceStack
{
    [DataContract]
    public class Authenticate : IPost, IReturn<AuthenticateResponse>, IMeta
    {
        [DataMember(Order = 1)] public string provider { get; set; }
        [DataMember(Order = 2)] public string State { get; set; }
        [DataMember(Order = 3)] public string oauth_token { get; set; }
        [DataMember(Order = 4)] public string oauth_verifier { get; set; }
        [DataMember(Order = 5)] public string UserName { get; set; }
        [DataMember(Order = 6)] public string Password { get; set; }
        [DataMember(Order = 7)] public bool? RememberMe { get; set; }
        // For Web Requests only can use ?continue or ?returnUrl
        // [DataMember(Order = 8)] public string Continue { get; set; }
        [DataMember(Order = 9)] public string ErrorView { get; set; }

        // digest auth
        [DataMember(Order = 10)] public string nonce { get; set; }
        [DataMember(Order = 11)] public string uri { get; set; }
        [DataMember(Order = 12)] public string response { get; set; }
        [DataMember(Order = 13)] public string qop { get; set; }
        [DataMember(Order = 14)] public string nc { get; set; }
        [DataMember(Order = 15)] public string cnonce { get; set; }

        [DataMember(Order = 16)] public bool? UseTokenCookie { get; set; }

        [DataMember(Order = 17)] public string AccessToken { get; set; }
        [DataMember(Order = 18)] public string AccessTokenSecret { get; set; }
        [DataMember(Order = 19)] public string scope { get; set; }

        [DataMember(Order = 20)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class AuthenticateResponse : IMeta, IHasSessionId, IHasBearerToken
    {
        public AuthenticateResponse()
        {
            this.ResponseStatus = new ResponseStatus();
        }

        [DataMember(Order = 1)] public string UserId { get; set; }
        [DataMember(Order = 2)] public string SessionId { get; set; }
        [DataMember(Order = 3)] public string UserName { get; set; }
        [DataMember(Order = 4)] public string DisplayName { get; set; }
        [DataMember(Order = 5)] public string ReferrerUrl { get; set; }
        [DataMember(Order = 6)] public string BearerToken { get; set; }
        [DataMember(Order = 7)] public string RefreshToken { get; set; }
        [DataMember(Order = 8)] public string ProfileUrl { get; set; }
        [DataMember(Order = 9)] public List<string> Roles { get; set; } 
        [DataMember(Order = 10)] public List<string> Permissions { get; set; } 

        [DataMember(Order = 11)] public ResponseStatus ResponseStatus { get; set; }
        [DataMember(Order = 12)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class Register : IPost, IReturn<RegisterResponse>, IMeta
    {
        [DataMember(Order = 1)] public string UserName { get; set; }
        [DataMember(Order = 2)] public string FirstName { get; set; }
        [DataMember(Order = 3)] public string LastName { get; set; }
        [DataMember(Order = 4)] public string DisplayName { get; set; }
        [DataMember(Order = 5)] public string Email { get; set; }
        [DataMember(Order = 6)] public string Password { get; set; }
        [DataMember(Order = 7)] public string ConfirmPassword { get; set; }
        [DataMember(Order = 8)] public bool? AutoLogin { get; set; }
        // For Web Requests only can use ?continue or ?returnUrl
        // [DataMember(Order = 9)] public string Continue { get; set; }
        [DataMember(Order = 10)] public string ErrorView { get; set; }
        [DataMember(Order = 11)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class RegisterResponse : IMeta
    {
        public RegisterResponse()
        {
            this.ResponseStatus = new ResponseStatus();
        }

        [DataMember(Order = 1)] public string UserId { get; set; }
        [DataMember(Order = 2)] public string SessionId { get; set; }
        [DataMember(Order = 3)] public string UserName { get; set; }
        [DataMember(Order = 4)] public string ReferrerUrl { get; set; }
        [DataMember(Order = 5)] public string BearerToken { get; set; }
        [DataMember(Order = 6)] public string RefreshToken { get; set; }

        [DataMember(Order = 7)] public ResponseStatus ResponseStatus { get; set; }
        [DataMember(Order = 8)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class AssignRoles : IPost, IReturn<AssignRolesResponse>, IMeta
    {
        public AssignRoles()
        {
            this.Roles = new List<string>();
            this.Permissions = new List<string>();
        }

        [DataMember(Order = 1)]
        public string UserName { get; set; }

        [DataMember(Order = 2)]
        public List<string> Permissions { get; set; }

        [DataMember(Order = 3)]
        public List<string> Roles { get; set; }
        [DataMember(Order = 4)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class AssignRolesResponse : IHasResponseStatus, IMeta
    {
        public AssignRolesResponse()
        {
            this.AllRoles = new List<string>();
            this.AllPermissions = new List<string>();
        }

        [DataMember(Order = 1)]
        public List<string> AllRoles { get; set; }

        [DataMember(Order = 2)]
        public List<string> AllPermissions { get; set; }

        [DataMember(Order = 3)] public Dictionary<string, string> Meta { get; set; }

        [DataMember(Order = 4)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class UnAssignRoles : IPost, IReturn<UnAssignRolesResponse>, IMeta
    {
        public UnAssignRoles()
        {
            this.Roles = new List<string>();
            this.Permissions = new List<string>();
        }

        [DataMember(Order = 1)]
        public string UserName { get; set; }

        [DataMember(Order = 2)]
        public List<string> Permissions { get; set; }

        [DataMember(Order = 3)]
        public List<string> Roles { get; set; }

        [DataMember(Order = 4)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class UnAssignRolesResponse : IHasResponseStatus, IMeta
    {
        public UnAssignRolesResponse()
        {
            this.AllRoles = new List<string>();
        }

        [DataMember(Order = 1)]
        public List<string> AllRoles { get; set; }

        [DataMember(Order = 2)]
        public List<string> AllPermissions { get; set; }

        [DataMember(Order = 3)] public Dictionary<string, string> Meta { get; set; }

        [DataMember(Order = 4)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class CancelRequest : IPost, IReturn<CancelRequestResponse>, IMeta
    {
        [DataMember(Order = 1)]
        public string Tag { get; set; }

        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class CancelRequestResponse : IHasResponseStatus, IMeta
    {
        [DataMember(Order = 1)]
        public string Tag { get; set; }

        [DataMember(Order = 2)]
        public TimeSpan Elapsed { get; set; }

        [DataMember(Order = 3)] public Dictionary<string, string> Meta { get; set; }
        
        [DataMember(Order = 4)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [Exclude(Feature.Soap)]
    [DataContract]
    [Route("/event-subscribers/{Id}", "POST")]
    public class UpdateEventSubscriber : IPost, IReturn<UpdateEventSubscriberResponse>
    {
        [DataMember(Order = 1)]
        public string Id { get; set; }
        [DataMember(Order = 2)]
        public string[] SubscribeChannels { get; set; }
        [DataMember(Order = 3)]
        public string[] UnsubscribeChannels { get; set; }
    }

    [DataContract]
    public class UpdateEventSubscriberResponse
    {
        [DataMember(Order = 1)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [Exclude(Feature.Soap)]
    public class GetEventSubscribers : IGet, IReturn<List<Dictionary<string, string>>>
    {
        public string[] Channels { get; set; }
    }

    [DataContract]
    public class GetApiKeys : IGet, IReturn<GetApiKeysResponse>, IMeta
    {
        [DataMember(Order = 1)] public string Environment { get; set; }
        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class GetApiKeysResponse : IHasResponseStatus, IMeta
    {
        [DataMember(Order = 1)] public List<UserApiKey> Results { get; set; }

        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
        [DataMember(Order = 3)] public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class RegenerateApiKeys : IPost, IReturn<RegenerateApiKeysResponse>, IMeta
    {
        [DataMember(Order = 1)] public string Environment { get; set; }
        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class RegenerateApiKeysResponse : IHasResponseStatus, IMeta
    {
        [DataMember(Order = 1)] public List<UserApiKey> Results { get; set; }

        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
        [DataMember(Order = 3)] public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class UserApiKey : IMeta
    {
        [DataMember(Order = 1)] public string Key { get; set; }
        [DataMember(Order = 2)] public string KeyType { get; set; }
        [DataMember(Order = 3)] public DateTime? ExpiryDate { get; set; }
        [DataMember(Order = 4)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class ConvertSessionToToken : IPost, IReturn<ConvertSessionToTokenResponse>, IMeta
    {
        [DataMember(Order = 1)]
        public bool PreserveSession { get; set; }
        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class ConvertSessionToTokenResponse : IMeta
    {
        [DataMember(Order = 1)]
        public Dictionary<string, string> Meta { get; set; }

        [DataMember(Order = 2)]
        public string AccessToken { get; set; }

        [DataMember(Order = 3)]
        public string RefreshToken { get; set; }

        [DataMember(Order = 4)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class GetAccessToken : IPost, IReturn<GetAccessTokenResponse>, IMeta
    {
        [DataMember(Order = 1)]
        public string RefreshToken { get; set; }
        [DataMember(Order = 2)] public bool? UseTokenCookie { get; set; }
        [DataMember(Order = 3)] public Dictionary<string, string> Meta { get; set; }
    }

    [DataContract]
    public class GetAccessTokenResponse : IHasResponseStatus, IMeta
    {
        [DataMember(Order = 1)]
        public string AccessToken { get; set; }

        [DataMember(Order = 2)] public Dictionary<string, string> Meta { get; set; }
        [DataMember(Order = 3)] public ResponseStatus ResponseStatus { get; set; }
    }

    [ExcludeMetadata]
    [DataContract]
    public class GetNavItems : IReturn<GetNavItemsResponse>
    {
        [DataMember(Order = 1)]
        public string Name { get; set; }
    }

    [DataContract]
    public class GetNavItemsResponse : IMeta
    {
        [DataMember(Order = 1)]
        public string BaseUrl { get; set; }
        [DataMember(Order = 2)]
        public List<NavItem> Results { get; set; }
        [DataMember(Order = 3)]
        public Dictionary<string, List<NavItem>> NavItemsMap { get; set; }
        [DataMember(Order = 4)]
        public Dictionary<string, string> Meta { get; set; }
        [DataMember(Order = 5)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [ExcludeMetadata]
    [DataContract]
    public class MetadataApp { }

    [DataContract]
    public class GetFile : IReturn<FileContent>, IGet
    {
        [DataMember(Order = 1)]
        public string Path { get; set; }
    }

    [DataContract]
    public class FileContent
    {
        [DataMember(Order = 1)]
        public string Name { get; set; }
        
        [DataMember(Order = 2)]
        public string Type { get; set; }
        
        [DataMember(Order = 3)]
        public int Length { get; set; }
        
        [DataMember(Order = 4)]
        public byte[] Body { get; set; }
        
        [DataMember(Order = 5)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class StreamFiles : IReturn<FileContent>
    {
        [DataMember(Order = 1)]
        public List<string> Paths { get; set; }
    }

    [DataContract]
    public class StreamServerEvents : IReturn<StreamServerEventsResponse>
    {
        [DataMember(Order = 1)]
        public string[] Channels { get; set; }
    }

    [DataContract]
    public class StreamServerEventsResponse
    {
        //ServerEventMessage
        [DataMember(Order = 1)]
        public long EventId { get; set; }
        [DataMember(Order = 2)]
        public string Channel { get; set; }
//        [DataMember(Order = 3)] //ignore returning Data body
        public string Data { get; set; }
        [DataMember(Order = 4)]
        public string Selector { get; set; }
        [DataMember(Order = 5)]
        public string Json { get; set; }
        [DataMember(Order = 6)]
        public string Op { get; set; }
        [DataMember(Order = 7)]
        public string Target { get; set; }
        [DataMember(Order = 8)]
        public string CssSelector { get; set; }
        [DataMember(Order = 9)]
        public Dictionary<string, string> Meta { get; set; }

        //ServerEventCommand
        [DataMember(Order = 10)]
        public string UserId { get; set; }
        [DataMember(Order = 11)]
        public string DisplayName { get; set; }
        [DataMember(Order = 12)]
        public string ProfileUrl { get; set; }
        [DataMember(Order = 13)]
        public bool IsAuthenticated { get; set; }
        [DataMember(Order = 14)]
        public string[] Channels { get; set; }
        [DataMember(Order = 15)]
        public long CreatedAt { get; set; }
        
        //ServerEventConnect
        [DataMember(Order = 21)]
        public string Id { get; set; }
        [DataMember(Order = 22)]
        public string UnRegisterUrl { get; set; }
        [DataMember(Order = 23)]
        public string UpdateSubscriberUrl { get; set; }
        [DataMember(Order = 24)]
        public string HeartbeatUrl { get; set; }
        [DataMember(Order = 25)]
        public long HeartbeatIntervalMs { get; set; }
        [DataMember(Order = 26)]
        public long IdleTimeoutMs { get; set; }
        
        [DataMember(Order = 30)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    [DataContract]
    public class DynamicRequest
    {
        [DataMember(Order = 1)]
        public Dictionary<string, string> Params { get; set; }
    }
    
    //Validation Rules
    [DataContract]
    public class GetValidationRules : IReturn<GetValidationRulesResponse>
    {
        [DataMember(Order = 1)]
        public string AuthSecret { get; set; }
        [DataMember(Order = 2)]
        public string Type { get; set; }
    }
    [DataContract]
    public class GetValidationRulesResponse
    {
        [DataMember(Order = 1)]
        public List<ValidationRule> Results { get; set; }
        [DataMember(Order = 2)]
        public ResponseStatus ResponseStatus { get; set; }
    }
    [DataContract]
    public class ModifyValidationRules : IReturnVoid
    {
        [DataMember(Order = 1)]
        public string AuthSecret { get; set; }
        [DataMember(Order = 2)]
        public List<ValidationRule> SaveRules { get; set; }

        [DataMember(Order = 3)]
        public int[] DeleteRuleIds { get; set; }

        [DataMember(Order = 4)]
        public int[] SuspendRuleIds { get; set; }

        [DataMember(Order = 5)]
        public int[] UnsuspendRuleIds { get; set; }
        
        [DataMember(Order = 6)]
        public bool? ClearCache { get; set; }
    }
    
    //CrudEvents
    [ExcludeMetadata]
    [DataContract]
    public class GetCrudEvents : QueryDb<CrudEvent>
    {
        [DataMember(Order = 1)]
        public string AuthSecret { get; set; }
        [DataMember(Order = 2)]
        public string Model { get; set; }
        [DataMember(Order = 3)]
        public string ModelId { get; set; }
    }

    [ExcludeMetadata]
    [DataContract]
    public class CheckCrudEvents : IReturn<CheckCrudEventsResponse>
    {
        [DataMember(Order = 1)]
        public string AuthSecret { get; set; }
        [DataMember(Order = 2)]
        public string Model { get; set; }
        [DataMember(Order = 3)]
        public List<string> Ids { get; set; }
    }
    
    [DataContract]
    public class CheckCrudEventsResponse : IHasResponseStatus
    {
        [DataMember(Order = 1)]
        public List<string> Results { get; set; }

        [DataMember(Order = 2)]
        public ResponseStatus ResponseStatus { get; set; }
    }

    /// <summary>
    /// Capture a CRUD Event
    /// </summary>
    [DataContract]
    public class CrudEvent : IMeta
    {
        [AutoIncrement]
        [DataMember(Order = 1)]
        public long Id { get; set; }
        /// <summary>
        /// AutoCrudOperation, e.g. Create, Update, Patch, Delete, Save
        /// </summary>
        [DataMember(Order = 2)]
        public string EventType { get; set; }
        /// <summary>
        /// DB Model
        /// </summary>
        [Index]
        [DataMember(Order = 3)]
        public string Model { get; set; }
        /// <summary>
        /// Primary Key of DB Model
        /// </summary>
        [Index]
        [DataMember(Order = 4)]
        public string ModelId { get; set; }
        /// <summary>
        /// Date of Event (UTC)
        /// </summary>
        [DataMember(Order = 5)]
        public DateTime EventDate { get; set; }
        /// <summary>
        /// Rows Updated if available
        /// </summary>
        [DataMember(Order = 6)]
        public long? RowsUpdated { get; set; }
        /// <summary>
        /// Request DTO Type
        /// </summary>
        [DataMember(Order = 7)]
        public string RequestType { get; set; }
        /// <summary>
        /// Serialized Request Body
        /// </summary>
        [DataMember(Order = 8)]
        public string RequestBody { get; set; }
        /// <summary>
        /// UserAuthId if Authenticated
        /// </summary>
        [DataMember(Order = 9)]
        public string UserAuthId { get; set; }
        /// <summary>
        /// UserName or unique User Identifier
        /// </summary>
        [DataMember(Order = 10)]
        public string UserAuthName { get; set; }
        /// <summary>
        /// 
        /// </summary>
        [DataMember(Order = 11)]
        public string RemoteIp { get; set; }
        /// <summary>
        /// URN format: urn:{requesttype}:{ModelId}
        /// </summary>
        [DataMember(Order = 12)]
        public string Urn { get; set; }

        /// <summary>
        /// Custom Reference Data with integer Primary Key
        /// </summary>
        [DataMember(Order = 13)]
        public int? RefId { get; set; }
        /// <summary>
        /// Custom Reference Data with non-integer Primary Key
        /// </summary>
        [DataMember(Order = 14)]
        public string RefIdStr { get; set; }
        /// <summary>
        /// Custom Metadata to attach to this event
        /// </summary>
        [DataMember(Order = 15)]
        public Dictionary<string, string> Meta { get; set; }
    }
    
}