@36node/auth-sdk 1.6.1 → 1.6.3

package/dist/types.gen.d.ts

@@ -0,0 +1,814 @@
+export type Captcha = {
+    code: string;
+    expireAt: string;
+    key: string;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type CreateCaptchaDto = {
+    code?: string;
+    expireAt?: string;
+    key: string;
+};
+export type CreateEmailRecordDto = {
+    status: EmailStatus;
+    from: string;
+    to: string;
+    subject: string;
+    content: string;
+    sentAt?: string;
+};
+export type CreateGroupDto = {
+    data?: string;
+    name: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    userCount?: number;
+};
+export type CreateNamespaceDto = {
+    data?: string;
+    desc?: string;
+    labels?: Array<string>;
+    name: string;
+    key: string;
+    ns?: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    defaultPassword?: string;
+    exportable?: boolean;
+    userCount?: number;
+};
+export type CreateRoleDto = {
+    permissions?: Array<string>;
+    key: string;
+    name: string;
+};
+export type CreateSessionDto = {
+    uid: string;
+    acl?: {
+        [key: string]: unknown;
+    };
+    expireAt: string;
+    client?: string;
+};
+export type CreateSmsRecordDto = {
+    status: SmsStatus;
+    phone: string;
+    sign: string;
+    template: string;
+    params?: string;
+    sentAt?: string;
+};
+export type CreateUserDto = {
+    password?: string;
+    readonly hasPassword?: boolean;
+    avatar?: string;
+    data?: string;
+    email?: string;
+    name?: string;
+    identity?: string;
+    identityVerifiedAt?: string;
+    identityVerified?: boolean;
+    intro?: string;
+    language?: string;
+    nickname?: string;
+    ns?: string;
+    phone?: string;
+    registerRegion?: string;
+    roles?: Array<string>;
+    super?: boolean;
+    username?: string;
+    employeeId?: string;
+    permissions?: Array<string>;
+    groups?: Array<string>;
+    active?: boolean;
+    inviteCode?: string;
+    status?: string;
+    expireAt?: string;
+    types?: Array<string>;
+};
+export type EmailRecord = {
+    status: EmailStatus;
+    from: string;
+    to: string;
+    subject: string;
+    content: string;
+    sentAt?: string;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type EmailStatus = 'pending' | 'sent';
+export type Group = {
+    data?: string;
+    name: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    userCount?: number;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type HealthCheckResult = {
+    message: string;
+};
+export type Industry = {
+    code: string;
+    name: string;
+    children: Array<Industry>;
+};
+export type LoginByEmailDto = {
+    email: string;
+    key: string;
+    code: string;
+};
+export type LoginByPhoneDto = {
+    phone: string;
+    key: string;
+    code: string;
+};
+export type LoginDto = {
+    login: string;
+    password: string;
+};
+export type Namespace = {
+    data?: string;
+    desc?: string;
+    labels?: Array<string>;
+    name: string;
+    key: string;
+    ns?: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    defaultPassword?: string;
+    exportable?: boolean;
+    userCount?: number;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type RefreshTokenDto = {
+    key: string;
+};
+export type Region = {
+    code: string;
+    nameZh: string;
+    namePinyin: string;
+    nameEn: string;
+    dialingPrefix: string;
+};
+export type RegisterByEmailDto = {
+    email: string;
+    key: string;
+    code: string;
+    ns?: string;
+};
+export type RegisterbyPhoneDto = {
+    phone: string;
+    key: string;
+    code: string;
+    ns?: string;
+};
+export type RegisterDto = {
+    username: string;
+    password: string;
+    ns?: string;
+};
+export type ResetPasswordDto = {
+    password?: string;
+};
+export type Role = {
+    key: string;
+    name: string;
+    permissions: Array<string>;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type SendEmailDto = {
+    from: string;
+    to: string;
+    subject: string;
+    content: string;
+};
+export type SendSmsDto = {
+    phone: string;
+    sign: string;
+    template: string;
+    params?: {
+        [key: string]: unknown;
+    };
+};
+export type Session = {
+    acl?: {
+        [key: string]: unknown;
+    };
+    expireAt: string;
+    key: string;
+    user: User;
+    client?: string;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type SessionWithToken = {
+    acl?: {
+        [key: string]: unknown;
+    };
+    expireAt: string;
+    key: string;
+    user: User;
+    client?: string;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+    token: string;
+    tokenExpireAt: string;
+};
+export type SignTokenDto = {
+    expiresIn: string;
+    acl?: {
+        [key: string]: unknown;
+    };
+    uid: string;
+};
+export type SmsRecord = {
+    status: SmsStatus;
+    phone: string;
+    sign: string;
+    template: string;
+    params?: string;
+    sentAt?: string;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type SmsStatus = 'pending' | 'sent';
+export type Token = {
+    token: string;
+    tokenExpireAt: string;
+};
+export type UpdateCaptchaDto = {
+    code?: string;
+    expireAt?: string;
+    key?: string;
+};
+export type UpdateEmailRecordDto = {
+    status?: EmailStatus;
+    from?: string;
+    to?: string;
+    subject?: string;
+    content?: string;
+    sentAt?: string;
+};
+export type UpdateGroupDto = {
+    data?: string;
+    name?: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    userCount?: number;
+};
+export type UpdateNamespaceDto = {
+    data?: string;
+    desc?: string;
+    labels?: Array<string>;
+    name?: string;
+    permissions?: Array<string>;
+    active?: boolean;
+    defaultPassword?: string;
+    exportable?: boolean;
+    userCount?: number;
+};
+export type UpdatePasswordDto = {
+    oldPassword?: string;
+    newPassword: string;
+};
+export type UpdateRoleDto = {
+    name?: string;
+    permissions?: Array<string>;
+};
+export type UpdateSessionDto = {
+    acl?: {
+        [key: string]: unknown;
+    };
+    expireAt?: string;
+    client?: string;
+    uid?: string;
+};
+export type UpdateSmsRecordDto = {
+    status?: SmsStatus;
+    phone?: string;
+    sign?: string;
+    template?: string;
+    params?: string;
+    sentAt?: string;
+};
+export type UpdateUserDto = {
+    readonly hasPassword?: boolean;
+    avatar?: string;
+    data?: string;
+    email?: string;
+    name?: string;
+    identity?: string;
+    identityVerifiedAt?: string;
+    identityVerified?: boolean;
+    intro?: string;
+    language?: string;
+    lastLoginIp?: string;
+    lastSeenAt?: string;
+    nickname?: string;
+    ns?: string;
+    phone?: string;
+    registerIp?: string;
+    registerRegion?: string;
+    roles?: Array<string>;
+    super?: boolean;
+    username?: string;
+    employeeId?: string;
+    permissions?: Array<string>;
+    groups?: Array<string>;
+    lastLoginAt?: string;
+    active?: boolean;
+    inviteCode?: string;
+    status?: string;
+    expireAt?: string;
+    types?: Array<string>;
+};
+export type User = {
+    password?: string;
+    readonly hasPassword?: boolean;
+    avatar?: string;
+    data?: string;
+    email?: string;
+    name?: string;
+    identity?: string;
+    identityVerifiedAt?: string;
+    identityVerified?: boolean;
+    intro?: string;
+    language?: string;
+    lastLoginIp?: string;
+    lastSeenAt?: string;
+    nickname?: string;
+    ns?: string;
+    phone?: string;
+    registerIp?: string;
+    registerRegion?: string;
+    roles?: Array<string>;
+    super?: boolean;
+    username?: string;
+    employeeId?: string;
+    permissions?: Array<string>;
+    groups?: Array<string>;
+    lastLoginAt?: string;
+    active?: boolean;
+    inviteCode?: string;
+    status?: string;
+    expireAt?: string;
+    types?: Array<string>;
+    id: string;
+    createdAt?: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+};
+export type HelloResponse = HealthCheckResult;
+export type HelloError = unknown;
+export type LoginData = {
+    body: LoginDto;
+};
+export type LoginResponse = SessionWithToken;
+export type LoginError = unknown;
+export type LoginByEmailData = {
+    body: LoginByEmailDto;
+};
+export type LoginByEmailResponse = SessionWithToken;
+export type LoginByEmailError = unknown;
+export type LoginByPhoneData = {
+    body: LoginByPhoneDto;
+};
+export type LoginByPhoneResponse = SessionWithToken;
+export type LoginByPhoneError = unknown;
+export type RegisterData = {
+    body: RegisterDto;
+};
+export type RegisterResponse = User;
+export type RegisterError = unknown;
+export type RegisterByPhoneData = {
+    body: RegisterbyPhoneDto;
+};
+export type RegisterByPhoneResponse = User;
+export type RegisterByPhoneError = unknown;
+export type RegisterByEmailData = {
+    body: RegisterByEmailDto;
+};
+export type RegisterByEmailResponse = User;
+export type RegisterByEmailError = unknown;
+export type SignTokenData = {
+    body: SignTokenDto;
+};
+export type SignTokenResponse = Token;
+export type SignTokenError = unknown;
+export type RefreshData = {
+    body: RefreshTokenDto;
+};
+export type RefreshResponse = SessionWithToken;
+export type RefreshError = unknown;
+export type CleanupAllDataResponse = void;
+export type CleanupAllDataError = unknown;
+export type CreateUserData = {
+    body: CreateUserDto;
+};
+export type CreateUserResponse = User;
+export type CreateUserError = unknown;
+export type ListUsersData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'lastLoginAt' | '-lastLoginAt' | 'expireAt' | '-expireAt';
+        active?: boolean;
+        email?: string;
+        expireAt_gte?: string;
+        expireAt_lte?: string;
+        groups?: Array<string>;
+        id?: Array<string>;
+        name?: string;
+        name_like?: string;
+        nickname_like?: string;
+        ns_tree?: string;
+        phone?: string;
+        registerRegion?: string;
+        roles?: Array<string>;
+        status?: string;
+        types?: Array<string>;
+        username?: string;
+        username_like?: string;
+    };
+};
+export type ListUsersResponse = Array<User>;
+export type ListUsersError = unknown;
+export type GetUserData = {
+    path: {
+        userId: string;
+    };
+};
+export type GetUserResponse = User;
+export type GetUserError = unknown;
+export type UpdateUserData = {
+    body: UpdateUserDto;
+    path: {
+        userId: string;
+    };
+};
+export type UpdateUserResponse = User;
+export type UpdateUserError = unknown;
+export type DeleteUserData = {
+    path: {
+        userId: string;
+    };
+};
+export type DeleteUserResponse = void;
+export type DeleteUserError = unknown;
+export type UpsertUserByEmployeeIdData = {
+    body: UpdateUserDto;
+    path: {
+        userEmployeeId: string;
+    };
+};
+export type UpsertUserByEmployeeIdResponse = User;
+export type UpsertUserByEmployeeIdError = unknown;
+export type VerifyIdentityData = {
+    path: {
+        userId: string;
+    };
+};
+export type VerifyIdentityResponse = User;
+export type VerifyIdentityError = unknown;
+export type ResetPasswordData = {
+    body: ResetPasswordDto;
+    path: {
+        userId: string;
+    };
+};
+export type ResetPasswordResponse = void;
+export type ResetPasswordError = unknown;
+export type UpdatePasswordData = {
+    body: UpdatePasswordDto;
+    path: {
+        userId: string;
+    };
+};
+export type UpdatePasswordResponse = void;
+export type UpdatePasswordError = unknown;
+export type CreateNamespaceData = {
+    body: CreateNamespaceDto;
+};
+export type CreateNamespaceResponse = Namespace;
+export type CreateNamespaceError = unknown;
+export type ListNamespacesData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'key' | '-key' | 'name' | '-name';
+        key?: string;
+        key_tree?: string;
+        labels?: Array<string>;
+        name_like?: string;
+        ns_tree?: string;
+    };
+};
+export type ListNamespacesResponse = Array<Namespace>;
+export type ListNamespacesError = unknown;
+export type GetNamespaceData = {
+    path: {
+        namespaceIdOrKey: string;
+    };
+};
+export type GetNamespaceResponse = Namespace;
+export type GetNamespaceError = unknown;
+export type UpdateNamespaceData = {
+    body: UpdateNamespaceDto;
+    path: {
+        namespaceIdOrKey: string;
+    };
+};
+export type UpdateNamespaceResponse = Namespace;
+export type UpdateNamespaceError = unknown;
+export type DeleteNamespaceData = {
+    path: {
+        namespaceId: string;
+    };
+};
+export type DeleteNamespaceResponse = void;
+export type DeleteNamespaceError = unknown;
+export type CreateSessionData = {
+    body: CreateSessionDto;
+};
+export type CreateSessionResponse = Session;
+export type CreateSessionError = unknown;
+export type ListSessionsData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'expireAt' | '-expireAt';
+        client?: string;
+        key?: string;
+        uid?: string;
+    };
+};
+export type ListSessionsResponse = Array<Session>;
+export type ListSessionsError = unknown;
+export type GetSessionData = {
+    path: {
+        sessionId: string;
+    };
+};
+export type GetSessionResponse = Session;
+export type GetSessionError = unknown;
+export type UpdateSessionData = {
+    body: UpdateSessionDto;
+    path: {
+        sessionId: string;
+    };
+};
+export type UpdateSessionResponse = Session;
+export type UpdateSessionError = unknown;
+export type DeleteSessionData = {
+    path: {
+        sessionId: string;
+    };
+};
+export type DeleteSessionResponse = void;
+export type DeleteSessionError = unknown;
+export type CreateGroupData = {
+    body: CreateGroupDto;
+};
+export type CreateGroupResponse = Group;
+export type CreateGroupError = unknown;
+export type ListGroupsData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt';
+        active?: boolean;
+        name?: string;
+        name_like?: string;
+    };
+};
+export type ListGroupsResponse = Array<Group>;
+export type ListGroupsError = unknown;
+export type GetGroupData = {
+    path: {
+        groupIdOrName: string;
+    };
+};
+export type GetGroupResponse = Group;
+export type GetGroupError = unknown;
+export type UpdateGroupData = {
+    body: UpdateGroupDto;
+    path: {
+        groupId: string;
+    };
+};
+export type UpdateGroupResponse = Group;
+export type UpdateGroupError = unknown;
+export type DeleteGroupData = {
+    path: {
+        groupId: string;
+    };
+};
+export type DeleteGroupResponse = void;
+export type DeleteGroupError = unknown;
+export type CreateCaptchaData = {
+    body: CreateCaptchaDto;
+};
+export type CreateCaptchaResponse = Captcha;
+export type CreateCaptchaError = unknown;
+export type ListCaptchasData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'expireAt' | '-expireAt';
+        code?: string;
+        key?: string;
+    };
+};
+export type ListCaptchasResponse = Array<Captcha>;
+export type ListCaptchasError = unknown;
+export type GetCaptchaData = {
+    path: {
+        captchaId: string;
+    };
+};
+export type GetCaptchaResponse = Captcha;
+export type GetCaptchaError = unknown;
+export type UpdateCaptchaData = {
+    body: UpdateCaptchaDto;
+    path: {
+        captchaId: string;
+    };
+};
+export type UpdateCaptchaResponse = Captcha;
+export type UpdateCaptchaError = unknown;
+export type DeleteCaptchaData = {
+    path: {
+        captchaId: string;
+    };
+};
+export type DeleteCaptchaResponse = void;
+export type DeleteCaptchaError = unknown;
+export type SendEmailData = {
+    body: SendEmailDto;
+};
+export type SendEmailResponse = void;
+export type SendEmailError = unknown;
+export type CreateEmailRecordData = {
+    body: CreateEmailRecordDto;
+};
+export type CreateEmailRecordResponse = EmailRecord;
+export type CreateEmailRecordError = unknown;
+export type ListEmailRecordsData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'sentAt' | '-sentAt';
+        createdAt_gt?: string;
+        createdAt_lt?: string;
+        from?: string;
+        sentAt_gt?: string;
+        sentAt_lt?: string;
+        status?: EmailStatus;
+        to?: string;
+    };
+};
+export type ListEmailRecordsResponse = Array<EmailRecord>;
+export type ListEmailRecordsError = unknown;
+export type GetEmailRecordData = {
+    path: {
+        emailRecordId: string;
+    };
+};
+export type GetEmailRecordResponse = EmailRecord;
+export type GetEmailRecordError = unknown;
+export type UpdateEmailRecordData = {
+    body: UpdateEmailRecordDto;
+    path: {
+        emailRecordId: string;
+    };
+};
+export type UpdateEmailRecordResponse = EmailRecord;
+export type UpdateEmailRecordError = unknown;
+export type DeleteEmailRecordData = {
+    path: {
+        emailRecordId: string;
+    };
+};
+export type DeleteEmailRecordResponse = void;
+export type DeleteEmailRecordError = unknown;
+export type SendSmsData = {
+    body: SendSmsDto;
+};
+export type SendSmsResponse = void;
+export type SendSmsError = unknown;
+export type CreateSmsRecordData = {
+    body: CreateSmsRecordDto;
+};
+export type CreateSmsRecordResponse = SmsRecord;
+export type CreateSmsRecordError = unknown;
+export type ListSmsRecordsData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt' | 'sentAt' | '-sentAt';
+        createdAt_gt?: string;
+        createdAt_lt?: string;
+        phone?: string;
+        sentAt_gt?: string;
+        sentAt_lt?: string;
+        sign?: string;
+        status?: SmsStatus;
+    };
+};
+export type ListSmsRecordsResponse = Array<SmsRecord>;
+export type ListSmsRecordsError = unknown;
+export type GetSmsRecordData = {
+    path: {
+        smsRecordId: string;
+    };
+};
+export type GetSmsRecordResponse = SmsRecord;
+export type GetSmsRecordError = unknown;
+export type UpdateSmsRecordData = {
+    body: UpdateSmsRecordDto;
+    path: {
+        smsRecordId: string;
+    };
+};
+export type UpdateSmsRecordResponse = SmsRecord;
+export type UpdateSmsRecordError = unknown;
+export type DeleteSmsRecordData = {
+    path: {
+        smsRecordId: string;
+    };
+};
+export type DeleteSmsRecordResponse = void;
+export type DeleteSmsRecordError = unknown;
+export type ListIndustriesResponse = Array<Industry>;
+export type ListIndustriesError = unknown;
+export type ListRegionsResponse = Array<Region>;
+export type ListRegionsError = unknown;
+export type CreateRoleData = {
+    body: CreateRoleDto;
+};
+export type CreateRoleResponse = Role;
+export type CreateRoleError = unknown;
+export type ListRolesData = {
+    query?: {
+        _limit?: number;
+        _offset?: number;
+        _sort?: 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt';
+        key?: string;
+        name?: string;
+        name_like?: string;
+    };
+};
+export type ListRolesResponse = Array<Role>;
+export type ListRolesError = unknown;
+export type GetRoleData = {
+    path: {
+        roleIdOrKey: string;
+    };
+};
+export type GetRoleResponse = Role;
+export type GetRoleError = unknown;
+export type UpdateRoleData = {
+    body: UpdateRoleDto;
+    path: {
+        roleId: string;
+    };
+};
+export type UpdateRoleResponse = Role;
+export type UpdateRoleError = unknown;
+export type DeleteRoleData = {
+    path: {
+        roleId: string;
+    };
+};
+export type DeleteRoleResponse = void;
+export type DeleteRoleError = unknown;