onsitesurvey/src/types/Inquiry.ts
keyy1315 f51b03cab7 docs: add annotations in SurveySale related Files
- Added detailed descriptions for search parameters and API functionalities in survey-sales routes.
- Improved documentation for inquiry-related hooks and types, enhancing clarity on their usage.
- Refactored comments for better readability and consistency across the codebase.
2025-06-10 17:13:35 +09:00

194 lines
4.1 KiB
TypeScript

/**
* @description 문의 목록 요청 파라미터 타입
*/
export type InquiryListRequest = {
/* 회사 코드 */
compCd: string
/* 언어 코드 */
langCd: string
/* 판매점 ID */
storeId: string
/* 사이트 유형 코드 */
siteTpCd: string
/* 검색 제목 */
schTitle: string | null
/* 검색 등록자 ID */
schRegId: string | null
/* 검색 시작 일자 */
schFromDt: string | null
/* 검색 종료 일자 */
schToDt: string | null
/* 검색 답변 여부 */
schAnswerYn: string | null
/* 로그인 ID */
loginId: string
}
/**
* @description 문의 목록 응답 타입
*/
export type InquiryList = {
/* 총 건수 */
totCnt: number
/* 행 번호 */
rowNumber: number
/* 회사 코드 */
compCd: string
/* 문의 번호 */
qnaNo: number
/* 문의 제목 */
qstTitle: string
/* 문의 등록 일자 */
regDt: string
/* 문의 등록자 이메일 */
regEmail: string
/* 문의 등록자 ID */
regId: string
/* 문의 등록자 이름 */
regNm: string
/* 답변 여부 */
answerYn: string
/* 첨부 여부 */
attachYn: string | null
/* 문의 대분류 코드 */
qnaClsLrgCd: string
/* 문의 중분류 코드 */
qnaClsMidCd: string
/* 문의 소분류 코드 */
qnaClsSmlCd: string | null
/* 문의 등록자 이름 */
regUserNm: string
}
/**
* @description 문의 상세 조회 요청 파라미터 타입
*/
export type InquiryDetailRequest = {
/* 회사 코드 */
compCd: string
/* 언어 코드 */
langCd: string
/* 문의 번호 */
qnaNo: number
/* 로그인 ID */
loginId: string
}
/**
* @description 문의 상세 조회 응답 타입
*/
export type Inquiry = {
/* 회사 코드 */
compCd: string
/* 문의 번호 */
qnaNo: number
/* 문의 제목 */
qstTitle: string
/* 문의 내용 */
qstContents: string
/* 문의 등록 일자 */
regDt: string
/* 문의 등록자 ID */
regId: string
/* 문의 등록자 이름 */
regNm: string
/* 문의 등록자 이메일 */
regEmail: string
/* 답변 여부 */
answerYn: string
/* 답변 내용 */
ansContents: string | null
/* 답변 등록 일자 */
ansRegDt: string | null
/* 답변 등록자 이름 */
ansRegNm: string | null
/* 판매점 ID */
storeId: string | null
/* 판매점 이름 */
storeNm: string | null
/* 문의 등록자 이름 */
regUserNm: string
/* 문의 등록자 전화번호 */
regUserTelNo: string | null
/* 문의 대분류 코드 */
qnaClsLrgCd: string
/* 문의 중분류 코드 */
qnaClsMidCd: string
/* 문의 소분류 코드 */
qnaClsSmlCd: string | null
/* 문의 첨부 파일 */
listFile: listFile[] | null
/* 답변 첨부 파일 */
ansListFile: listFile[] | null
}
/**
* @description 문의 첨부 파일 타입
*/
export type listFile = {
/* 파일 번호 */
fileNo: number
/* 인코딩 파일 번호 */
encodeFileNo: string
/* 소스 파일 이름 */
srcFileNm: string
/* 파일 코스 */
fileCours: string
/* 파일 크기 */
fileSize: number
/* 등록 일자 */
regDt: string
}
/**
* @description 문의 등록 요청 파라미터 타입
*/
export type InquiryRequest = {
/* 회사 코드 */
compCd: string
/* 사이트 유형 코드 */
siteTpCd: string
/* 문의 대분류 코드 */
qnaClsLrgCd: string
/* 문의 중분류 코드 */
qnaClsMidCd: string
/* 문의 소분류 코드 */
qnaClsSmlCd: string | null
/* 문의 제목 */
title: string
/* 문의 내용 */
contents: string
/* 문의 등록자 ID */
regId: string
/* 판매점 ID */
storeId: string
/* 문의 등록자 이름 */
regUserNm: string
/* 문의 등록자 전화번호 */
regUserTelNo: string | null
/* 문의 이메일 */
qstMail: string
}
/**
* @description 문의 등록 응답 타입
*/
export type InquirySaveResponse = {
/* 건수 */
cnt: number | null
/* 문의 번호 */
qnaNo: number
/* 메일 여부 */
mailYn: string
}
/**
* @description 공통 코드 타입
*/
export type CommonCode = {
headCd: string
code: string
name: string
refChar1: string
}