@portone/browser-sdk 0.0.23 → 0.1.0

package/dist/v2/entity/Customer.d.ts

@@ -1,17 +1,92 @@
-import { Entity } from '../index.js';
+import type { Address } from './Address.js';
+import { Gender } from './Gender.js';
 export type Customer = {
-    customerId?: string;
-    fullName?: string;
-    firstName?: string;
-    lastName?: string;
-    phoneNumber?: string;
-    email?: string;
-    address?: Entity.Address;
-    zipcode?: string;
-    gender?: Entity.Gender;
-    birthYear?: string;
-    birthMonth?: string;
-    birthDay?: string;
-    firstNameKana?: string;
-    lastNameKana?: string;
+    /**
+     * **구매자 ID**
+     *
+     * 스마트로, KG이니시스 SBPS 일본결제에서 사용합니다.
+     *
+     * 토스페이먼츠와 스마트로의 빌링키 발급에서 사용합니다.
+     */
+    customerId?: string | undefined;
+    /**
+     * **구매자 전체 이름**
+     *
+     * `fullName`이 사용되는 PG에서 `fullName`이 없고 `firstName`과 `lastName`이 있는 경우 `${lastName} ${firstName}`이 대신 사용됩니다.
+     */
+    fullName?: string | undefined;
+    /**
+     * **구매자 성이 아닌 이름**
+     *
+     * 페이팔에서 구매자 페이팔 계정 소유자의 이름을 지정합니다.
+     */
+    firstName?: string | undefined;
+    /**
+     * **구매자 성**
+     *
+     * 페이팔에서 구매자 페이팔 계정 소유자의 성을 지정합니다.
+     */
+    lastName?: string | undefined;
+    /**
+     * **구매자 휴대전화 번호**
+     *
+     * 숫자만 입력합니다.
+     */
+    phoneNumber?: string | undefined;
+    /**
+     * **구매자 이메일 주소**
+     *
+     * 올바른 형식의 이메일 주소여야 합니다.
+     */
+    email?: string | undefined;
+    /**
+     * **구매자 주소**
+     */
+    address?: Address | undefined;
+    /**
+     * **구매자 우편번호**
+     */
+    zipcode?: string | undefined;
+    /**
+     * **구매자 성별**
+     *
+     * 정보성 필드입니다.
+     */
+    gender?: Gender | undefined;
+    /**
+     * **구매자 출생년도**
+     *
+     * `"1990"`과 같은 형식입니다.
+     *
+     * KG이니시스 통합인증에서 `flgFixedUser`가 `Y`인 경우 필수입니다.
+     */
+    birthYear?: string | undefined;
+    /**
+     * **구매자 출생월**
+     *
+     * `"12"`, `"07"`과 같은 형식입니다.
+     *
+     * KG이니시스 통합인증에서 `flgFixedUser`가 `Y`인 경우 필수입니다.
+     */
+    birthMonth?: string | undefined;
+    /**
+     * **구매자 출생일**
+     *
+     * `"25"`, `"08"`과 같은 형식입니다.
+     *
+     * KG이니시스 통합인증에서 `flgFixedUser`가 `Y`인 경우 필수입니다.
+     */
+    birthDay?: string | undefined;
+    /**
+     * **구매자 일본어 성이 아닌 이름 후리가나(읽는 법)**
+     *
+     * KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.
+     */
+    firstNameKana?: string | undefined;
+    /**
+     * **구매자 일본어 성 후리가나(읽는 법)**
+     *
+     * KG이니시스 JPPG 일본 편의점 결제에서 필수입니다. 최대 20바이트입니다.
+     */
+    lastNameKana?: string | undefined;
 };

package/dist/v2/entity/EasyPayPaymentMethod.d.ts

@@ -1,7 +1,25 @@
+/**
+ * 간편결제 결제수단
+ */
 export declare const EasyPayPaymentMethod: {
+    /**
+     * 카드
+     */
     readonly CARD: "CARD";
+    /**
+     * 포인트(충전, 적립) 결제
+     */
     readonly CHARGE: "CHARGE";
+    /**
+     * 계좌결제
+     */
     readonly TRANSFER: "TRANSFER";
+    /**
+     * 포인트 및 계좌결제가 모두 가능한 경우
+     */
     readonly MONEY: "MONEY";
 };
-export type EasyPayPaymentMethod = typeof EasyPayPaymentMethod[keyof typeof EasyPayPaymentMethod];
+/**
+ * 간편결제 결제수단
+ */
+export type EasyPayPaymentMethod = (typeof EasyPayPaymentMethod)[keyof typeof EasyPayPaymentMethod];

package/dist/v2/entity/EasyPayProvider.d.ts

@@ -1,24 +1,180 @@
+/**
+ * PG 제휴로 간편결제를 이용할 때, 간편결제 UI를 직접 호출할 수 있는 간편결제
+ */
 export declare const EasyPayProvider: {
-    readonly PAYCO: "EASY_PAY_PROVIDER_PAYCO";
-    readonly SAMSUNGPAY: "EASY_PAY_PROVIDER_SAMSUNGPAY";
-    readonly SSGPAY: "EASY_PAY_PROVIDER_SSGPAY";
-    readonly KAKAOPAY: "EASY_PAY_PROVIDER_KAKAOPAY";
-    readonly NAVERPAY: "EASY_PAY_PROVIDER_NAVERPAY";
-    readonly CHAI: "EASY_PAY_PROVIDER_CHAI";
-    readonly LPAY: "EASY_PAY_PROVIDER_LPAY";
-    readonly KPAY: "EASY_PAY_PROVIDER_KPAY";
-    readonly TOSSPAY: "EASY_PAY_PROVIDER_TOSSPAY";
-    readonly LGPAY: "EASY_PAY_PROVIDER_LGPAY";
-    readonly APPLEPAY: "EASY_PAY_PROVIDER_APPLEPAY";
-    readonly PINPAY: "EASY_PAY_PROVIDER_PINPAY";
-    readonly SKPAY: "EASY_PAY_PROVIDER_SKPAY";
-    readonly TOSS_BRANDPAY: "EASY_PAY_PROVIDER_TOSS_BRANDPAY";
-    readonly HYPHEN: "EASY_PAY_PROVIDER_HYPHEN";
-    readonly PAYPAY: "EASY_PAY_PROVIDER_PAYPAY";
-    readonly AMAZONPAY: "EASY_PAY_PROVIDER_AMAZONPAY";
-    readonly RAKUTENPAY: "EASY_PAY_PROVIDER_RAKUTENPAY";
-    readonly DBARAI: "EASY_PAY_PROVIDER_DBARAI";
-    readonly AUPAY: "EASY_PAY_PROVIDER_AUPAY";
-    readonly MERPAY: "EASY_PAY_PROVIDER_MERPAY";
+    /**
+     * 페이코
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - 스마트로
+     * - KSNET
+     * - 한국결제네트웍스
+     * - 웰컴페이먼츠
+     */
+    readonly PAYCO: "PAYCO";
+    /**
+     * 삼성페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - NHN KCP
+     * - 스마트로
+     * - 한국결제네트웍스
+     */
+    readonly SAMSUNGPAY: "SAMSUNGPAY";
+    /**
+     * SSG페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - NHN KCP
+     * - KSNET
+     */
+    readonly SSGPAY: "SSGPAY";
+    /**
+     * 카카오페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - 스마트로
+     * - NHN KCP
+     * - KSNET
+     * - 한국결제네트웍스
+     * - 웰컴페이먼츠
+     */
+    readonly KAKAOPAY: "KAKAOPAY";
+    /**
+     * 네이버페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - 스마트로
+     * - NHN KCP
+     * - KSNET
+     * - 한국결제네트웍스
+     */
+    readonly NAVERPAY: "NAVERPAY";
+    /**
+     * 차이페이
+     */
+    readonly CHAI: "CHAI";
+    /**
+     * L페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - 스마트로
+     * - KSNET
+     * - 웰컴페이먼츠
+     */
+    readonly LPAY: "LPAY";
+    /**
+     * K페이
+     */
+    readonly KPAY: "KPAY";
+    /**
+     * 토스페이
+     *
+     * - 토스페이먼츠
+     * - KG이니시스
+     * - NHN KCP
+     * - 스마트로
+     * - 한국결제네트웍스
+     * - 웰컴페이먼츠
+     */
+    readonly TOSSPAY: "TOSSPAY";
+    /**
+     * LG페이
+     *
+     * - 토스페이먼츠
+     */
+    readonly LGPAY: "LGPAY";
+    /**
+     * 애플페이
+     *
+     * - 토스페이먼츠
+     * - 나이스페이먼츠
+     * - KG이니시스
+     * - NHN KCP
+     */
+    readonly APPLEPAY: "APPLEPAY";
+    /**
+     * 핀페이
+     *
+     * - 스마트로
+     */
+    readonly PINPAY: "PINPAY";
+    /**
+     * SK페이
+     *
+     * - 나이스페이먼츠
+     */
+    readonly SKPAY: "SKPAY";
+    /**
+     * 토스 브랜드페이
+     */
+    readonly TOSS_BRANDPAY: "TOSS_BRANDPAY";
+    /**
+     * 하이픈
+     */
+    readonly HYPHEN: "HYPHEN";
+    /**
+     * 라인페이
+     *
+     * - 스마트로
+     */
+    readonly LINEPAY: "LINEPAY";
+    /**
+     * 티머니
+     *
+     * - 스마트로
+     */
+    readonly TMONEY: "TMONEY";
+    /**
+     * PayPay
+     *
+     * - KG이니시스 JPPG/SBPS 일본결제
+     */
+    readonly PAYPAY: "PAYPAY";
+    /**
+     * 아마존페이
+     *
+     * - KG이니시스 JPPG 일본결제
+     */
+    readonly AMAZONPAY: "AMAZONPAY";
+    /**
+     * 라쿠텐페이
+     *
+     * - KG이니시스 JPPG 일본결제
+     */
+    readonly RAKUTENPAY: "RAKUTENPAY";
+    /**
+     * dBarai
+     *
+     * - KG이니시스 JPPG 일본결제
+     */
+    readonly DBARAI: "DBARAI";
+    /**
+     * auPAY
+     *
+     * - KG이니시스 JPPG 일본결제
+     */
+    readonly AUPAY: "AUPAY";
+    /**
+     * Merpay
+     *
+     * - KG이니시스 JPPG 일본결제
+     */
+    readonly MERPAY: "MERPAY";
 };
-export type EasyPayProvider = typeof EasyPayProvider[keyof typeof EasyPayProvider];
+/**
+ * PG 제휴로 간편결제를 이용할 때, 간편결제 UI를 직접 호출할 수 있는 간편결제
+ */
+export type EasyPayProvider = (typeof EasyPayProvider)[keyof typeof EasyPayProvider] | `EASY_PAY_PROVIDER_${(typeof EasyPayProvider)[keyof typeof EasyPayProvider]}`;

package/dist/v2/entity/FreeInstallmentPlan.d.ts

@@ -1,7 +1,14 @@
-import { Entity } from '../index.js';
+import { CardCompany } from './CardCompany.js';
 /**
- * 상점 부담 무이자 할부 옵션
- * 예) 삼성카드에 대해 2, 3개월 무이자 할부 적용, 신한카드에 대해 2, 3, 4, 5, 6개월 무이자 할부 적용
+ * **무이자 할부 설정**
+ *
+ * 고객사가 부담하는 무이자 할부 설정입니다. 이자 수수료를 가맹점이 부담하여 구매자에게 무이자로 할부를 제공합니다.
+ *
+ * ## 사용 예시
+ *
+ * 삼성카드에 대해 2, 3개월 무이자 할부 적용, 신한카드에 대해 2, 3, 4, 5, 6개월 무이자 할부 적용
+ *
+ * ```typescript
  * freeInstallmentPlans: [
  *  {
  *    cardCompany: 'CARD_COMPANY_SAMSUNG',
@@ -12,8 +19,22 @@ import { Entity } from '../index.js';
  *    months: [2, 3, 4, 5, 6]
  *  }
  * ]
+ * ```
+ *
+ * ## 주의사항
+ *
+ * - 무이자 할부 수수료는 가맹점이 부담합니다
+ * - PG사와의 계약에 따라 무이자 할부 제공 가능 여부가 결정됩니다
+ * - 카드사별로 최소 결제 금액 제한이 있을 수 있습니다 (일반적으로 5만원 이상)
+ * - 일부 카드사는 특정 개월수에 대해서만 무이자 할부를 허용할 수 있습니다
  */
 export type FreeInstallmentPlan = {
-    cardCompany: Entity.CardCompany;
+    /**
+     * **무이자 할부를 제공하는 카드사**
+     */
+    cardCompany: CardCompany;
+    /**
+     * **무이자 할부를 제공하는 개월 수**
+     */
     months: number[];
 };

package/dist/v2/entity/Gender.d.ts

@@ -1,6 +1,21 @@
+/**
+ * 구매자 성별
+ */
 export declare const Gender: {
-    readonly MALE: "GENDER_MALE";
-    readonly FEMALE: "GENDER_FEMALE";
-    readonly OTHER: "GENDER_OTHER";
+    /**
+     * 남성
+     */
+    readonly MALE: "MALE";
+    /**
+     * 여성
+     */
+    readonly FEMALE: "FEMALE";
+    /**
+     * 기타
+     */
+    readonly OTHER: "OTHER";
 };
-export type Gender = typeof Gender[keyof typeof Gender];
+/**
+ * 구매자 성별
+ */
+export type Gender = (typeof Gender)[keyof typeof Gender] | `GENDER_${(typeof Gender)[keyof typeof Gender]}`;

package/dist/v2/entity/GiftCertificateType.d.ts

@@ -1,8 +1,26 @@
+/**
+ * **상품권 종류**
+ */
 export declare const GiftCertificateType: {
-    readonly BOOKNLIFE: "GIFT_CERTIFICATE_TYPE_BOOKNLIFE";
-    readonly SMART_MUNSANG: "GIFT_CERTIFICATE_TYPE_SMART_MUNSANG";
-    readonly CULTURELAND: "GIFT_CERTIFICATE_TYPE_CULTURELAND";
-    readonly HAPPYMONEY: "GIFT_CERTIFICATE_TYPE_HAPPYMONEY";
-    readonly CULTURE_GIFT: "GIFT_CERTIFICATE_TYPE_CULTURE_GIFT";
+    /**
+     * 도서문화상품권
+     * | KG이니시스
+     */
+    readonly BOOKNLIFE: "BOOKNLIFE";
+    /**
+     * 스마트문상, (구)게임문화상품권
+     */
+    readonly SMART_MUNSANG: "SMART_MUNSANG";
+    /**
+     * 컬쳐랜드 문화상품권
+     */
+    readonly CULTURELAND: "CULTURELAND";
+    /**
+     * 문화상품권
+     */
+    readonly CULTURE_GIFT: "CULTURE_GIFT";
 };
-export type GiftCertificateType = typeof GiftCertificateType[keyof typeof GiftCertificateType];
+/**
+ * **상품권 종류**
+ */
+export type GiftCertificateType = (typeof GiftCertificateType)[keyof typeof GiftCertificateType] | `GIFT_CERTIFICATE_TYPE_${(typeof GiftCertificateType)[keyof typeof GiftCertificateType]}`;

package/dist/v2/entity/Iframe.d.ts

@@ -1,3 +1,9 @@
+/**
+ * **결제창이 iframe 방식일 경우 결제창에 적용할 속성**
+ */
 export type Iframe = {
-    dim?: boolean;
+    /**
+     * `false`로 설정하면 결제창 배경이 투명해집니다.
+     */
+    dim?: boolean | undefined;
 };

package/dist/v2/entity/Installment.d.ts

@@ -1,24 +1,57 @@
-import { Entity } from '../index.js';
-import { OneOfType } from '../../utils.js';
+import type { FreeInstallmentPlan } from './FreeInstallmentPlan.js';
+import type { InstallmentMonthOption } from './InstallmentMonthOption.js';
+/**
+ * **할부 설정**
+ *
+ * 신용카드 결제 시 할부 관련 설정을 제어합니다.
+ *
+ * ## 사용 예시
+ *
+ * ### 3개월 고정 할부
+ *
+ * ```typescript
+ * installment: {
+ *   monthOption: {
+ *     fixedMonth: 3
+ *   }
+ * }
+ * ```
+ *
+ * ### 2~6개월 할부 선택
+ *
+ * ```typescript
+ * installment: {
+ *   monthOption: {
+ *     availableMonthList: [2, 3, 4, 5, 6]
+ *   }
+ * }
+ * ```
+ *
+ * ### 무이자 할부 설정 (삼성카드 2,3개월)
+ *
+ * ```typescript
+ * installment: {
+ *   freeInstallmentPlans: [{
+ *     cardCompany: 'CARD_COMPANY_SAMSUNG',
+ *     months: [2, 3]
+ *   }]
+ * }
+ * ```
+ *
+ * ## 주의사항
+ *
+ * - 일반적으로 5만원 이상부터 할부가 가능합니다
+ * - 1개월 할부는 일시불과 동일하게 처리됩니다
+ * - 카드 다이렉트 호출 시 고정 할부만 가능한 PG사가 있습니다
+ * - 무이자 할부는 가맹점이 수수료를 부담하는 방식입니다
+ */
 export type Installment = {
-    freeInstallmentPlans?: Entity.FreeInstallmentPlan[];
     /**
-     * 할부 개월수 옵션
-     * - fixedMonth: 고정 할부 개월수
-     * - availableMonthList: 렌더링을 허용 할 할부 개월수 리스트
-     *
-     * 예1) 3개월 고정 할부 개월수
-     * monthOption: {
-     *  fixedMonth: 3
-     * }
-     *
-     * 예2) 2, 3, 4, 5, 6개월 리스트 할부 개월수
-     * monthOption: {
-     *  availableMonthList: [2, 3, 4, 5, 6]
-     * }
+     * **무이자 할부 설정**
      */
-    monthOption?: OneOfType<{
-        fixedMonth: number;
-        availableMonthList: number[];
-    }>;
+    freeInstallmentPlans?: FreeInstallmentPlan[] | undefined;
+    /**
+     * **할부 개월 수 설정**
+     */
+    monthOption?: InstallmentMonthOption | undefined;
 };

package/dist/v2/entity/InstallmentMonthOption.d.ts

@@ -0,0 +1,41 @@
+import type { OneOfType } from '../../utils.js';
+/**
+ * **할부 개월 수 설정**
+ *
+ * 할부 결제 시 할부 개월 수를 설정할 수 있습니다.
+ *
+ * `fixedMonth`와 `availableMonthList` 중 하나만 제공해주세요.
+ *
+ * - fixedMonth: 고정 할부 개월 수
+ * - availableMonthList: 렌더링을 허용 할 할부 개월 수 리스트
+ *
+ * 예1) 3개월 고정 할부 개월 수
+ *
+ * ```js
+ * monthOption: {
+ *  fixedMonth: 3
+ * }
+ * ```
+ *
+ * 예2) 2, 3, 4, 5, 6개월 리스트 할부 개월 수
+ *
+ * ```js
+ * monthOption: {
+ *  availableMonthList: [2, 3, 4, 5, 6]
+ * }
+ * ```
+ */
+export type InstallmentMonthOption = OneOfType<{
+    /**
+     * **구매자가 선택할 수 없도록 고정된 할부 개월수**
+     *
+     * 구매자가 할부 개월 수를 선택할 수 있도록 하려면 `availableMonthList`를 사용해주세요.
+     */
+    fixedMonth?: number | undefined;
+    /**
+     * **구매자가 선택할 수 있는 할부 개월수 리스트**
+     *
+     * 구매자가 할부 개월 수를 선택할 수 없도록 하려면 `fixedMonth`를 사용해주세요.
+     */
+    availableMonthList?: number[] | undefined;
+}>;

package/dist/v2/entity/IssueBillingKeyUIType.d.ts

@@ -1,4 +1,4 @@
 export declare const IssueBillingKeyUIType: {
     readonly PAYPAL_RT: "PAYPAL_RT";
 };
-export type IssueBillingKeyUIType = typeof IssueBillingKeyUIType[keyof typeof IssueBillingKeyUIType];
+export type IssueBillingKeyUIType = (typeof IssueBillingKeyUIType)[keyof typeof IssueBillingKeyUIType];

package/dist/v2/entity/Locale.d.ts

@@ -1,11 +1,73 @@
+/**
+ * **UI 언어**
+ *
+ * KG이니시스, 스마트로, KSNET, 웰컴페이먼츠 (PC), 한국결제네트웍스, 엑심베이에서 설정 가능하며, PG마다 지원하는 언어 목록은 차이가 있습니다.
+ */
 export declare const Locale: {
+    /**
+     * 한국어
+     *
+     * - KG이니시스
+     * - 스마트로
+     * - KSNET
+     * - 웰컴페이먼츠 (PC)
+     * - 한국결제네트웍스
+     * - 엑심베이
+     */
     readonly KO_KR: "KO_KR";
+    /**
+     * 영어
+     *
+     * - KG이니시스
+     * - 스마트로
+     * - KSNET
+     * - 웰컴페이먼츠 (PC)
+     * - 한국결제네트웍스
+     * - 엑심베이
+     */
     readonly EN_US: "EN_US";
+    /**
+     * 중국어 (중국 본토)
+     *
+     * - KG이니시스 (PC)
+     * - 웰컴페이먼츠 (PC)
+     * - 엑심베이
+     */
     readonly ZH_CN: "ZH_CN";
+    /**
+     * 중국어 (대만)
+     *
+     * - 엑심베이
+     */
     readonly ZH_TW: "ZH_TW";
+    /**
+     * 일본어
+     *
+     * - 엑심베이
+     */
     readonly JA_JP: "JA_JP";
+    /**
+     * 러시아어
+     *
+     * - 엑심베이
+     */
     readonly RU_RU: "RU_RU";
+    /**
+     * 타이어
+     *
+     * - 엑심베이
+     */
     readonly TH_TH: "TH_TH";
+    /**
+     * 베트남어
+     *
+     * - 엑심베이
+     */
     readonly VI_VN: "VI_VN";
 };
-export type Locale = typeof Locale[keyof typeof Locale];
+/**
+ * **UI 언어**
+ *
+ * KG이니시스, 스마트로, KSNET, 웰컴페이먼츠 (PC), 한국결제네트웍스, 엑심베이에서 설정 가능하며, PG마다 지원하는 언어 목록은 차이가 있습니다.
+ */
+export type Locale = (typeof Locale)[keyof typeof Locale];