@bootpay/backend-js
Version:
Bootpay Server Side Package for Node.js
59 lines (58 loc) • 1.92 kB
TypeScript
import { BootpayCommerceResource, BootpayCommerceResponse } from '../../commerce-resource';
import { CommerceUser, UserListParams, UserTokenResponse, UserLoginResponse } from '../types';
export declare class UserModule {
private bootpay;
constructor(bootpay: BootpayCommerceResource);
/**
* 사용자 토큰 발급
* @param userId 사용자 ID
*/
token(userId: string): Promise<BootpayCommerceResponse<UserTokenResponse>>;
/**
* 회원가입
* @param user 사용자 정보
*/
join(user: CommerceUser): Promise<BootpayCommerceResponse<CommerceUser>>;
/**
* 중복 체크
* @param key 체크할 필드 (login_id, phone, email 등)
* @param value 체크할 값
*/
checkExist(key: string, value: string): Promise<BootpayCommerceResponse<{
exists: boolean;
}>>;
/**
* 본인인증 데이터 조회
* @param standId 인증 ID
*/
authenticationData(standId: string): Promise<BootpayCommerceResponse<any>>;
/**
* 로그인
* @param loginId 로그인 ID
* @param loginPw 비밀번호
*/
login(loginId: string, loginPw: string): Promise<BootpayCommerceResponse<UserLoginResponse>>;
/**
* 사용자 목록 조회
* @param params 조회 파라미터
*/
list(params?: UserListParams): Promise<BootpayCommerceResponse<{
items: CommerceUser[];
total: number;
}>>;
/**
* 사용자 상세 조회
* @param userId 사용자 ID
*/
detail(userId: string): Promise<BootpayCommerceResponse<CommerceUser>>;
/**
* 사용자 정보 수정
* @param user 사용자 정보
*/
update(user: CommerceUser): Promise<BootpayCommerceResponse<CommerceUser>>;
/**
* 사용자 삭제 (회원탈퇴)
* @param userId 사용자 ID
*/
delete(userId: string): Promise<BootpayCommerceResponse<null>>;
}