fake-iamport-server/lib/controllers/FakeIamportCertificationsController.d.ts

Fake iamport server for testing

import { IIamportCertification } from "iamport-server-api/lib/structures/IIamportCertification";
import { IIamportResponse } from "iamport-server-api/lib/structures/IIamportResponse";
import { IIamportUser } from "iamport-server-api/lib/structures/IIamportUser";
export declare class FakeIamportCertificationsController {
    /**
     * 본인인증 정보 열람하기.
     *
     * `certiciations.at` 은 본인인증 정보를 열람할 때 사용하는 API 함수이다.
     *
     * 다만 이 API 함수를 통하여 열람한 본인인증 정보 {@link IIamportCertification} 이
     * 곧 OTP 인증까지 마쳐 본인인증을 모두 마친 레코드라는 보장은 없다. 본인인증의 완결
     * 여부는 오직, {@link IIamportCertification.certified} 값을 직접 검사해봐야만 알
     * 수 있기 때문이다.
     *
     * @param imp_uid 대상 본인인증 정보의 {@link IIamportCertification.imp_uid}
     * @returns 본인인증 정보
     *
     * @security bearer
     * @author Samchon
     */
    at(_user: IIamportUser.IAccessor, imp_uid: string): IIamportResponse<IIamportCertification>;
    /**
     * 본인인증 요청하기.
     *
     * `certifications.otp.request` 는 아임포트 서버에 본인인증을 요청하는 API 함수이다.
     * 이 API 를 호출하면 본인인증 대상자의 핸드폰으로 OTP 문자가 전송되며, 본인인증
     * 대상자가 {@link certifications.otp.confirm} 을 통하여 이 OTP 번호를 정확히
     * 입력함으로써, 본인인증이 완결된다.
     *
     * 또한 본인인증 대상자가 자신의 핸드폰으로 전송된 OTP 문자를 입력하기 전에도,
     * 여전히해당 본인인증 내역은 {@link certifications.at} 함수를 통하여 조회할 수 있다.
     * 다만, 이 때 리턴되는 {@link IIamportCertification} 에서 인증의 완결 여부를
     * 지칭하는 {@link IIamportCertification.certified} 값은 `false` 이다.
     *
     * @param input 본인인증 요청 정보
     * @returns 진행 중인 본인인증의 식별자 정보
     *
     * @security bearer
     * @author Samchon
     */
    request(_user: IIamportUser.IAccessor, input: IIamportCertification.ICreate): IIamportResponse<IIamportCertification.IAccessor>;
    /**
     * 본인인증 시 발급된 OTP 코드 입력하기.
     *
     * `certifications.otp.confirm` 는 {@link certifications.otp.request} 를 통하여
     * 발급된 본인인증 건에 대하여, 본인인증 대상자의 휴대폰으로 전송된 OTP 번호를
     * 검증하고, 입력한 OTP 번호가 맞거든 해당 본인인증 건을 승인하여 완료 처리해주는
     * API 함수이다.
     *
     * 이처럼 본인인증을 완료하거든, 해당 본인인증 건 {@link IIamportCertification} 의
     * {@link IIamportCertification.certified} 값이 비로소 `true` 로 변경되어,
     * 비로소 완결된다.
     *
     * @param imp_uid 대상 본인인증 정보의 {@link IIamportCertification.imp_uid}
     * @param input OTP 코드
     * @returns 인증 완료된 본인인증 정보
     *
     * @security bearer
     * @author Samchon
     */
    confirm(_user: IIamportUser.IAccessor, imp_uid: string, input: IIamportCertification.IConfirm): IIamportResponse<IIamportCertification>;
    /**
     * 본인인증 정보 삭제하기.
     *
     * @param imp_uid 대상 본인인증 정보의 {@link IIamportCertification.imp_uid}
     * @returns 삭제된 본인인증 정보
     *
     * @security bearer
     * @author Samchon
     */
    erase(_user: IIamportUser.IAccessor, imp_uid: string): IIamportResponse<IIamportCertification>;
}