@carsayo/types 1.1.0 → 1.1.2

package/dist/types/providers/coocon-usedcar/interface.d.ts

@@ -0,0 +1,300 @@
+/**
+ * @description 중고차 정보
+ */
+export interface CooconUsedCarInfo {
+    /** DB에 저장된 중고차 정보 Id */
+    id: string;
+    /**
+     * 자동차 등록번호
+     * @example 03가0000
+     */
+    carName: string;
+    /** 소유자명 */
+    ownerName: string | null;
+    carInfo: {
+        /** 차대번호 */
+        vin: string;
+        /** 등록증 차명 */
+        regName: string;
+        /** 최초등록일 (YYYYMMDD) */
+        firstdate: string;
+        /** 연식 */
+        year: string;
+        /**
+         * @description 수입차 여부
+         * @case true: 수입차
+         * @case false: 국산차
+         */
+        isForeign: boolean;
+        /** 제조사명 */
+        makername: string;
+        /** 대표모델명 */
+        classname: string;
+        /** 세부모델명 */
+        modelname: string;
+        /** 대표등급명 */
+        seriesname1: string;
+        /** 세부등급명 */
+        seriesname2: string;
+        /** 신차등급명 */
+        seriesname: string;
+        /** 차종명 */
+        cargubun: string;
+        /** 모델 대표이미지 URL */
+        modelimage: string;
+        /** 용도 */
+        usegubun: string;
+        /** 배기량 */
+        displacement: number;
+        /** 연료 */
+        fuel: string;
+        /** 변속기 */
+        gearbox: string;
+        /** 색상 */
+        color: string;
+        /** 연비 */
+        stdmileage: string;
+        /** 신차가격 */
+        newprice: number;
+        /** 승차인원 */
+        seating: string;
+        /** 엔진타입 */
+        enType: string;
+        /** 옵션 리스트 */
+        optlist: OptList | null;
+        /** 옵션 테이블 */
+        option_table: Coocon_CarOptionDetail[];
+    };
+    /** 해당 차량의 선택옵션 리스트 테이블 */
+    seloptlist?: SeloptList;
+    /**
+     * @description 주행거리 기준 시세
+     * @requires rst_code 1
+     */
+    mileageprice?: MileagePrice;
+    /**
+     * @description 카마트 기준 시세
+     * @requires rst_code 1 | 2
+     */
+    usedprice?: Usedprice;
+    /** 생성일 */
+    created_at: Date;
+}
+/** Coocon data */
+export interface OptList {
+    /** 출고옵션명 */
+    name: string;
+    /** 옵션금액 (없으면 null) */
+    price: number | null;
+}
+export interface Coocon_CarOption {
+    /** 옵션 키 1 */
+    option_key1: string;
+    /** 옵션 키 2 */
+    option_key2: string;
+    /** 옵션 키 3 */
+    option_key3: string;
+    /**
+     * 옵션 여부
+     * @case O: 기본옵션, S: 선택
+     */
+    option_flag: "O" | "S";
+}
+/** Coocon_CarOption 키값이 파싱된 정보 */
+export interface Coocon_CarOptionDetail {
+    /** 옵션 이름 1 */
+    cate1Name: string;
+    /** 옵션 이름 2 */
+    cate2Name: string;
+    /** 옵션 이름 3 */
+    cate3Name: string;
+    /**
+     * 옵션 여부
+     * @case O: 기본옵션, S: 선택
+     */
+    option_flag: "O" | "S";
+}
+interface SeloptList {
+    /** 선택옵션명 */
+    optname: string;
+    /** 옵션금액 */
+    optprice: string;
+}
+interface ModelList {
+    /** 모델키 */
+    modelno: number;
+    /** 모델명 */
+    modelname: string;
+    /** 옵션금액 */
+    serieslist: {
+        /** 신차등급키 */
+        seriesno: string;
+        /** 신차등급명 */
+        seriesname: string;
+        /** 신차가격 */
+        seriesprice: number;
+    }[];
+}
+export interface Usedprice {
+    /** 기준년월
+     * @description YYYYMM
+     */
+    stdym: string;
+    /** 시세 */
+    price: number;
+    /** 감가율
+     * @description 소수점 최대 6자리까지출력
+     */
+    rate: string;
+    /** 잔존가치 * @description 소수점 최대 6자리까지출력
+     */
+    rvalue: number;
+}
+export interface MileagePrice {
+    /** 시세 */
+    price: number;
+    /** 주행거리 */
+    mileage: number;
+}
+/**
+ * @description 사고이력 정보
+ */
+export interface CooconAccidentHistoryInfo {
+    /**
+     * @description DB에 저장된 사고이력 정보 Id
+     */
+    id: string;
+    /**
+     * @description 자동차 등록번호
+     * @example 03가0000
+     */
+    carName: string;
+    /** 정보조회일자 */
+    SEARCH_DATE: string;
+    /** 자동차 용도변경이력 */
+    CAR_USED_CHANGE_HISTORY: string;
+    /** 대여용도 사용이력(렌터카) */
+    RENT_CAR_HISTORY: string;
+    /** 영업용도 사용이력 */
+    BUSINESS_HISTORY: string;
+    /** 관용용도 사용이력 */
+    COMMON_USE_HISTORY: string;
+    /** 자동차번호 변경횟수 */
+    CAR_NUM_CHANGE_COUNT: string;
+    /** 소유자 변경횟수 */
+    OWNER_CHANGE_COUNT: string;
+    /** 자동차보험 특수사고이력-전손 */
+    TOTAL_LOSS_HISTORY: string;
+    /** 자동차보험 특수사고이력-도난 */
+    ROBBERY_HISTORY: string;
+    /** 자동차보험 특수사고이력-침수(전손) */
+    FLOODING_TOTAL_LOSS_HISTORY: string;
+    /** 자동차보험 특수사고이력-침수(분손) */
+    FLOODING_PARTIAL_LOSS_HISTORY: string;
+    /** 보험사고이력:내차피해 */
+    MY_CAR_DAMAGE_HISTORY: string;
+    /** 보험사고이력:타차피해 */
+    OTHER_CAR_DAMAGE_HISTORY: string;
+    /** 보험 미가입 기간 */
+    UNDERACARRIAGE_DATE: string;
+    /** 최초보험가입일자 */
+    FIRST_CAR_INSURANCE_DATE: string;
+    /** 최근주행거리 */
+    LAST_MILEAGE: string;
+    /** 최근주행거리기록일자 */
+    LAST_MILEAGE_DATE: string;
+    /** 차량가액범위 */
+    CAR_AMOUNT_RANGE: string;
+    /** 내차 보험처리이력 횟수 */
+    MY_COUNT: string;
+    /** 내차 보험처리이력 */
+    RESP_MY_DATA: {
+        /** 사고일자 */
+        MY_ACCIDENT_DATE: string;
+        /** 보험금 */
+        MY_INSURANCE_BENEFIT: string;
+        /** 수리비용 */
+        MY_REPAIR_COST: string;
+        /** 부품 */
+        MY_COMPONENT: string;
+        /** 공임 */
+        MY_PAY: string;
+        /** 도장 */
+        MY_PAINTING: string;
+    }[];
+    /** 타차보험처리이력 반복건수 */
+    OTHER_COUNT: string;
+    /** 타차보험처리이력 리스트 */
+    RESP_OTHER_DATA: {
+        /** 사고일자 */
+        OTHER_ACCIDENT_DATE: string;
+        /** 보험금 */
+        OTHER_INSURANCE_BENEFIT: string;
+        /** 수리비용 */
+        OTHER_REPAIR_COST: string;
+        /** 부품 */
+        OTHER_COMPONENT: string;
+        /** 공임 */
+        OTHER_PAY: string;
+        /** 도장 */
+        OTHER_PAINTING: string;
+    }[];
+    /** 타차가해이력 반복건수 */
+    MY_FAULT_COUNT: string;
+    /** 타차가해이력 리스트 */
+    RESP_MY_FAULT_DATA: {
+        RESP_MY_FAULT_DATA: string;
+        MY_FAULT_ACCIDENT_DATE: string;
+    }[];
+    /** 주행거리정보 반복건수 */
+    MY_MILE_COUNT: string;
+    /** 주행거리정보 리스트 */
+    RESP_MY_MILE_DATA: {
+        /** 날짜 */
+        MY_MILE_DATE: string;
+        /** 주행거리 */
+        MY_MILE_AGE: string;
+        /** 제공처 */
+        MY_MILE_PROVIDER: string;
+    }[];
+    /** 소유자변경이력 반복건수 */
+    MY_CHANGE_COUNT: string;
+    /** 소유자변경이력 리스트 */
+    RESP_MY_CHANGE_DATA: {
+        /** 변경등록일 */
+        MY_CHANGE_CHANGE_DATE: string;
+        /** 소유자변경 */
+        MY_CHANGE_CHANGE_NAME: string;
+        /** 차량번호 */
+        MY_CHANGE_CAR_NUMBER: string;
+        /** 차량용도 */
+        MY_CHANGE_CAR_USES: string;
+    }[];
+}
+/**
+ * @description 내차 정보 조회 결과
+ */
+export interface SearchedUsedCarInfo {
+    /** 조회 결과
+     * @case "success" 조회 성공
+     * @case "searchMore" 상세 조회 필요
+     * @case "checkInput" 인풋 확인 필요
+     * @case "error" 조회 실패, 메시지 확인
+     */
+    result: "success" | "searchMore" | "checkInput" | "error";
+    message: string;
+    /** 상세 검색을 위한 정보 */
+    searchDetailInfo?: {
+        ts_key: string;
+        modelList: ModelList;
+    };
+    /**
+     * @description 쿠콘에서 조회하여 DB에 기록된 차량 정보
+     */
+    usedCarInfo?: CooconUsedCarInfo;
+    /**
+     * @description 쿠콘에서 조회하여 DB에 기록된 사고이력 정보
+     */
+    accidentHistory?: CooconAccidentHistoryInfo | null;
+}
+export {};

package/dist/types/providers/firebase-message/dto.d.ts

@@ -0,0 +1,83 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { MemberType } from "../../modules";
+export declare class SetFirebaseCloudMessageTokenDTO {
+    fcm_token: string;
+}
+/**
+ * @description 특정 토픽을 구독 중인 FCM 토큰에 대해 푸시 메시지를 전송합니다.
+ */
+export declare class SendTopicPushMessageDTO {
+    /**
+     * 푸시 메시지 제목
+     */
+    title?: string;
+    /**
+     * 푸시 메시지 내용
+     */
+    content: string;
+    /**
+     * @description 메시지를 특정 토픽에 전송합니다.
+     * 기본적으로 자기 회원 타입(customer, dealer)을 구독합니다. 따라서 모든 일반회원, 딜러에 대해 메시지 전송이 가능합니다.
+     */
+    topic: MemberType;
+    /**
+     * 메시지 타입
+     */
+    messageType?: string;
+    /**
+     * @description 앱에서 해당 푸시 알람을 눌렀을 때 이동할 경로를 정의합니다.
+     */
+    redirectPath?: string;
+}
+/**
+ * @description 특정 회원에게 푸시 메시지를 전송합니다.
+ */
+export declare class SendMemberPushMessageDTO {
+    /**
+     * 메시지를 받을 회원 ID
+     */
+    memberId: string;
+    /**
+     * 푸시 메시지 제목
+     */
+    title?: string;
+    /**
+     * 푸시 메시지 내용
+     */
+    content: string;
+    /**
+     * @description 메시지 분류를 위한 값으로 임의의 값을 입력할 수 있습니다.
+     * @example 전체메시지, 단일메시지, 광고메시지 등
+     */
+    messageType?: string;
+    /**
+     * @description 앱에서 해당 푸시 알람을 눌렀을 때 이동할 경로를 정의합니다.
+     */
+    redirectPath?: string;
+}
+/**
+ * @description 특정 회원 리스트에 푸시 메시지를 전송합니다.
+ */
+export declare class SendMemberListPushMessageDTO {
+    /**
+     * @description 메시지를 보낼 회원 ID 리스트
+     */
+    memberIdList: string[];
+    /**
+     * 푸시 메시지 제목
+     */
+    title?: string;
+    /**
+     * 푸시 메시지 내용
+     */
+    content: string;
+    /**
+     * @description 메시지 분류를 위한 값으로 임의의 값을 입력할 수 있습니다.
+     * @example 전체메시지, 단일메시지, 광고메시지 등
+     */
+    messageType?: string;
+    /**
+     * @description 앱에서 해당 푸시 알람을 눌렀을 때 이동할 경로를 정의합니다.
+     */
+    redirectPath?: string;
+}

package/dist/types/providers/firebase-message/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dto";
+export * from "./interface";

package/dist/types/providers/firebase-message/interface.d.ts

@@ -0,0 +1,4 @@
+export interface FCMSendResponse {
+    successCount: number;
+    failureCount: number;
+}

package/dist/types/providers/gabia-sms/dto.d.ts

@@ -0,0 +1,31 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { MemberIdDTO } from "../../modules";
+/**
+ * @description 특정 휴대전화번호에 푸시 메시지를 전송합니다
+ */
+export declare class SendPhoneNumberSmsDTO {
+    phoneNumber: string;
+    /**
+     * 푸시 메시지 내용
+     */
+    content: string;
+    /**
+     * @description 메시지 분류를 위한 값으로 임의의 값을 입력할 수 있습니다
+     * @example 전체메시지, 단일메시지, 광고메시지 등
+     */
+    type: string;
+}
+/**
+ * @description 특정 회원에게 푸시 메시지를 전송합니다
+ */
+export declare class SendMemberSmsDTO extends MemberIdDTO {
+    /**
+     * 푸시 메시지 내용
+     */
+    content: string;
+    /**
+     * @description 메시지 분류를 위한 값으로 임의의 값을 입력할 수 있습니다
+     * @example 전체메시지, 단일메시지, 광고메시지 등
+     */
+    type: string;
+}

package/dist/types/providers/gabia-sms/index.d.ts

@@ -0,0 +1 @@
+export * from "./dto";

package/dist/types/providers/index.d.ts

@@ -0,0 +1,7 @@
+/** 카사요 서버단에서 외부 서비스와 연계된 부분의 타입 지정 파일입니다 */
+export * from "./coocon-usedcar";
+export * from "./firebase-message";
+export * from "./gabia-sms";
+export * from "./mailer";
+export * from "./niceapi";
+export * from "./nicepayment";

package/dist/types/providers/mailer/dto.d.ts

@@ -0,0 +1,4 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+export declare class EmailVerifyDTO {
+    emailVerifyToken: string;
+}

package/dist/types/providers/mailer/index.d.ts

@@ -0,0 +1 @@
+export * from "./dto";

package/dist/types/providers/niceapi/dto.d.ts

@@ -0,0 +1,15 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+export declare class InitIdentityDTO {
+    returnUrl?: string;
+}
+export declare class VerifyDTO {
+    identity_id: string;
+}
+export declare class VerifyTokenPhoneNumberDTO {
+    identityVerifyToken: string;
+    /** 같은 전화번호가 있으면 실패합니다 */
+    phoneNumber: string;
+}
+export declare class VerifyResponseDTO {
+    identityVerifyToken: string;
+}

package/dist/types/providers/niceapi/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./dto";
+export * from "./interface";

package/dist/types/providers/niceapi/interface.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @interface NiceapiGetIdentityClientKey
+ * @description 나이스 API에서 신원 확인을 위한 클라이언트 키 요청 정보 인터페이스입니다.
+ */
+export interface NiceapiGetIdentityClientKey {
+    /**
+     * @property {string} id - 이 요청의 ID값입니다.
+     */
+    id: string;
+    /**
+     * @property {string} token_version_id - 암호화토큰요청_API 응답으로 받은 값.
+     */
+    token_version_id: string;
+    /**
+     * @property {string} enc_data - 암호화한 요청 정보.
+     */
+    enc_data: string;
+    /**
+     * @property {string} integrity_value - enc_data의 무결성 값.
+     */
+    integrity_value: string;
+}

package/dist/types/providers/nicepayment/dto.d.ts

@@ -0,0 +1,60 @@
+/** DTO는 서버단에 요청을 보낼 때 사용하는 클래스 유형으로 서버단에서 이 곳에 정의된 대로 유효성 검사를 처리합니다. */
+import { PaymentState } from "./type";
+export declare class SearchPaymentAdditionalInfoDTO {
+    /** true일 경우 응답 내에 state별 숫자가 나옵니다. */
+    paymentState?: boolean;
+    /** true일 경우 응답 내에 총 가격 합산이 나옵니다. */
+    totalPrice?: boolean;
+}
+/** 결제 리스트 검색 */
+export declare class SearchPaymentDTO {
+    skip?: number;
+    take: number;
+    interval: PaymentIntervalDTO | null;
+    option: PaymentOptionDTO | null;
+    /** 회원 닉네임, 본명 검색 */
+    keyword?: string;
+    additionalInfo?: SearchPaymentAdditionalInfoDTO;
+}
+export declare const PaymentIntervalTarget: {
+    created_at: string;
+    paid_at: string;
+    canceled_at: string;
+};
+export type PaymentIntervalTarget = keyof typeof PaymentIntervalTarget;
+export declare class PaymentIntervalDTO {
+    target: PaymentIntervalTarget;
+    /** null일 경우 검색 시작일시를 정의하지 않습니다 */
+    start: Date | null;
+    /** null일 경우 검색 종료일시를 정의하지 않습니다 */
+    end: Date | null;
+}
+export declare class PaymentOptionDTO {
+    paymentStateList?: PaymentState[];
+    /** 정의될 경우 해당 회원의 결제 내역만 검색합니다 */
+    memberId?: string;
+}
+export declare class InitNicePaymentDTO {
+    /** 결제 상품명 */
+    name: string;
+    /** 결제 금액 */
+    amount: number;
+    /**
+     * 결제 확인 후 리다이렉트할 URL
+     * 해당 페이지에서 결제가 성공했는지, 실패했는지 확인 후 서비스를 재개합니다
+     */
+    redirectUrl: string;
+    /**
+     * 결제 도중 에러가 발생하면 리다이렉트할 URL
+     * 해당 URL에서 에러를 클라이언트에게 보여줍니다
+     * 정의되지 않을 경우 글로벌 에러 페이지로 리다이렉트합니다
+     */
+    failedUrl?: string;
+}
+export declare class GetNicePaymentDTO {
+    paymentId: string;
+}
+export declare class CancelPaymentDTO {
+    paymentId: string;
+    reason?: string;
+}

package/dist/types/providers/nicepayment/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./dto";
+export * from "./interface";
+export * from "./type";