Add faxOptions

Author: Palbahngmiyine

package.json

@@ -11,7 +11,7 @@
     "sdk",
     "korean sms"
   ],
-  "homepage": "https://solapi.github.io/solapi-nodejs",
+  "homepage": "https://solapi.com",
   "bugs": {
     "url": "https://github.com/solapi/solapi-nodejs/issues"
   },
@@ -28,7 +28,7 @@
   "source": "src/solapi.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "module": "dist/index.mjs",
+  "module": "dist/index.module.js",
   "files": [
     "/dist"
   ],

src/models/message.ts

@@ -1,5 +1,6 @@
 import {KakaoOption, kakaoOptionRequest} from './kakao/kakaoOption';
 import {RcsOption, RcsOptionRequest} from './rcs/rcsOption';
+import {FileIds} from '../requests/messageRequest';
 
 /**
  * @name MessageType 메시지 유형(단문 문자, 장문 문자, 알림톡 등)
@@ -9,11 +10,15 @@ import {RcsOption, RcsOptionRequest} from './rcs/rcsOption';
  * ATA: 알림톡
  * CTA: 친구톡
  * CTI: 사진 한장이 포함된 친구톡
+ * NSA: 네이버 스마트알림(톡톡)
  * RCS_SMS: RCS 단문 문자
  * RCS_LMS: RCS 장문 문자
  * RCS_MMS: RCS 사진 문자
  * RCS_TPL: RCS 템플릿
- * NSA: 네이버 스마트알림(톡톡)
+ * RCS_ITPL: RCS 이미지 템플릿
+ * RCS_LTPL: RCS LMS 템플릿 문자
+ * FAX: 팩스
+ * VOICE: 음성문자(TTS)
  */
 export type MessageType =
   | 'SMS'
@@ -22,11 +27,15 @@ export type MessageType =
   | 'ATA'
   | 'CTA'
   | 'CTI'
+  | 'NSA'
   | 'RCS_SMS'
   | 'RCS_LMS'
   | 'RCS_MMS'
   | 'RCS_TPL'
-  | 'NSA';
+  | 'RCS_ITPL'
+  | 'RCS_LTPL'
+  | 'FAX'
+  | 'VOICE';
 
 export type MessageParameter = {
   to: string | Array<string>;
@@ -41,6 +50,7 @@ export type MessageParameter = {
   country?: string;
   customFields?: Record<string, string>;
   replacements?: Array<object>;
+  faxOptions?: FileIds;
 };
 
 /**
@@ -135,6 +145,8 @@ export class Message {
    */
   customFields?: Record<string, string>;
 
+  faxOptions?: FileIds;
+
   constructor(parameter: MessageParameter) {
     this.to = parameter.to;
     this.from = parameter.from;
@@ -152,6 +164,6 @@ export class Message {
     }
     this.customFields = parameter.customFields;
     this.replacements = parameter.replacements;
+    this.faxOptions = parameter.faxOptions;
   }
 }
-

src/models/rcs/rcsOption.ts

@@ -1,33 +1,82 @@
 import {RcsButton} from './rcsButton';
+
+/**
+ * RCS 사진문자 발송 시 필요한 오브젝트
+ */
 export type AdditionalBody = {
+  /**
+   * 슬라이드 제목
+   */
   title: string;
+  /**
+   * 슬라이드 설명
+   */
   description: string;
+  /**
+   * MMS 발송 시 사용되는 이미지의 고유 아이디. 이미지 타입이 MMS일 경우에만 사용 가능합니다.
+   * @see https://console.solapi.com/storage
+   * @see https://developers.solapi.com/references/storage
+   */
   imaggeId?: string;
+  /**
+   * 	슬라이드에 추가되는 버튼 목록, 최대 2개
+   */
   buttons?: Array<RcsButton>;
-}
+};
 
+/**
+ * RCS 발송을 위한 파라미터 타입
+ */
 export type RcsOptionRequest = {
+  /**
+   * RCS 채널의 브랜드 ID
+   */
   brandId: string;
+  /**
+   * RCS 템플릿 ID
+   */
   templateId?: string;
+  /**
+   * 문자 복사 가능 여부
+   */
   copyAllowed?: boolean;
-  mmsType?: 'M3' | 'S3' | 'M4' | 'S4' | 'M5' | 'S5' | 'M6' | 'S6'; // (M: 중간 사이즈. S: 작은 사이즈. 숫자: 사진 개수)
-  commercialType?: boolean;
+  /**
+   * RCS 템플릿 대체 문구 입력 오브젝트
+   * 예) { #{치환문구1} : "치환문구 값" }
+   */
   variables?: Record<string, string>;
+  /**
+   * 사진 문자 타입. 타입: "M3", "S3", "M4", "S4", "M5", "S5", "M6", "S6" (M: 중간 사이즈. S: 작은 사이즈. 숫자: 사진 개수)
+   */
+  mmsType?: 'M3' | 'S3' | 'M4' | 'S4' | 'M5' | 'S5' | 'M6' | 'S6';
+  /**
+   * 광고 문자 여부
+   */
+  commercialType?: boolean;
+  /**
+   * 대체발송여부. false 로 설정했을 경우 해당건이 발송에 실패하게 됐을 때 문자로(SMS, LMS, MMS)로 대체 발송됩니다. 대체 발송이 될 경우 기존 가격은 환불되고 각 문자 타입에 맞는 금액이 차감됩니다. 기본값: false
+   */
   disableSms?: boolean;
+  /**
+   * RCS 사진 문자 전송 시 필요한 오브젝트
+   */
   additionalBody?: AdditionalBody;
-  buttons: Array<RcsButton>;
+  /**
+   * RCS 템플릿 버튼 배열
+   */
+  buttons?: Array<RcsButton>;
 };
 
 export class RcsOption {
   brandId: string;
   templateId?: string;
   copyAllowed?: boolean;
+  variables?: Record<string, string>;
   mmsType?: 'M3' | 'S3' | 'M4' | 'S4' | 'M5' | 'S5' | 'M6' | 'S6'; // (M: 중간 사이즈. S: 작은 사이즈. 숫자: 사진 개수)
   commercialType?: boolean;
-  variables?: Record<string, string>;
   disableSms?: boolean;
   additionalBody?: AdditionalBody;
-  buttons: Array<RcsButton>;
+  buttons?: Array<RcsButton>;
 
   constructor(parameter: RcsOptionRequest) {
     this.brandId = parameter.brandId;

src/requests/messageRequest.ts

@@ -115,7 +115,11 @@ export type RequestConfig = {
   url: string;
 };
 
-export type FileType = 'KAKAO' | 'MMS' | 'DOCUMENT' | 'RCS';
+export type FileIds = {
+  fileIds: Array<string>;
+};
+
+export type FileType = 'KAKAO' | 'MMS' | 'DOCUMENT' | 'RCS' | 'FAX';
 
 export type FileUploadRequest = {
   file: string;