@portone/browser-sdk 0.0.23 → 0.1.0

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

@@ -1,38 +1,56 @@
+import type { OneOfType } from '../../utils.js';
+import type { OfferPeriodRange } from './OfferPeriodRange.js';
 /**
- * 제공 기간
+ * **서비스 제공 기간**
+ *
+ * range와 interval 중 하나를 입력해주세요.
+ *
  * - range: 제공 기간 범위
  * - interval: 제공 기간 주기
  *
  * 예1) 2023년 1월 1일 00시 00분 00초(KST) ~
+ *
+ * ```js
  * range: {
  *  from: '2023-01-01T00:00:00+09:00'
  * }
+ * ```
  *
  * 예2) ~ 2023년 1월 1일 00시 00분 00초(KST)
+ *
+ * ```js
  * range: {
  *  to: '2023-01-01T00:00:00+09:00'
  * }
+ * ```
  *
  * 예3) 2023년 1월 1일 00시 00분 00초(KST) ~ 2023년 12월 31일 23시 59분 59초(KST)
+ *
+ * ```js
  * range: {
  *  from: '2023-12-31T23:59:59+09:00'
  *  to: '2023-01-01T00:00:00+09:00'
  * }
+ * ```
  *
  * 예4) 30일 주기
- * interval: '30d'
+ * `interval: '30d'`
  *
  * 예5) 6개월 주기
- * interval: '6m'
+ * `interval: '6m'`
  *
  * 예6) 1년 주기
- * interval: '1y'
+ * `interval: '1y'`
  */
-export type OfferPeriod = {
-    range?: {
-        from: string;
-    } | {
-        to: string;
-    };
-    interval?: `${number}d` | `${number}m` | `${number}y`;
-};
+export type OfferPeriod = OneOfType<{
+    /**
+     * **기간 범위**
+     */
+    range?: OfferPeriodRange | undefined;
+    /**
+     * **제공 주기**
+     *
+     * 제공 주기 (`${number}d | ${number}m | ${number}y` 형태로 입력할 수 있습니다.)
+     */
+    interval?: string | undefined;
+}>;

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

@@ -0,0 +1,7 @@
+import type { OfferPeriodRangeFrom } from './OfferPeriodRangeFrom.js';
+import type { OfferPeriodRangeTo } from './OfferPeriodRangeTo.js';
+import type { OfferPeriodRangeFromTo } from './OfferPeriodRangeFromTo.js';
+/**
+ * **기간 범위**
+ */
+export type OfferPeriodRange = OfferPeriodRangeFrom | OfferPeriodRangeTo | OfferPeriodRangeFromTo;

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

@@ -0,0 +1,9 @@
+/**
+ * **시작 시점만 있는 기간 범위**
+ */
+export type OfferPeriodRangeFrom = {
+    /**
+     * **시작 시점**
+     */
+    from: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * **시작 지점과 종료 지점이 모두 있는 기간 범위**
+ */
+export type OfferPeriodRangeFromTo = {
+    /**
+     * **시작 시점**
+     */
+    from: string;
+    /**
+     * **종료 지점**
+     */
+    to: string;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * **종료 지점만 있는 기간 범위**
+ */
+export type OfferPeriodRangeTo = {
+    /**
+     * **종료 지점**
+     */
+    to: string;
+};

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

@@ -1 +1,27 @@
-export type PayMethod = 'CARD' | 'VIRTUAL_ACCOUNT' | 'TRANSFER' | 'MOBILE' | 'GIFT_CERTIFICATE' | 'EASY_PAY' | 'PAYPAL' | 'ALIPAY' | 'CONVENIENCE_STORE';
+import { PaymentPayMethod } from './PaymentPayMethod.js';
+/**
+ * **결제수단 구분코드**
+ *
+ * PG사별 지원되는 결제수단이 모두 상이합니다.
+ *
+ * [각 PG사별 결제 연동 가이드](https://developers.portone.io/opi/ko/integration/pg/v2/readme?v=v2)를 참고하세요
+ */
+export declare const PayMethod: {
+    readonly CARD: "CARD";
+    readonly VIRTUAL_ACCOUNT: "VIRTUAL_ACCOUNT";
+    readonly TRANSFER: "TRANSFER";
+    readonly MOBILE: "MOBILE";
+    readonly GIFT_CERTIFICATE: "GIFT_CERTIFICATE";
+    readonly EASY_PAY: "EASY_PAY";
+    readonly PAYPAL: "PAYPAL";
+    readonly ALIPAY: "ALIPAY";
+    readonly CONVENIENCE_STORE: "CONVENIENCE_STORE";
+};
+/**
+ * **결제수단 구분코드**
+ *
+ * PG사별 지원되는 결제수단이 모두 상이합니다.
+ *
+ * [각 PG사별 결제 연동 가이드](https://developers.portone.io/opi/ko/integration/pg/v2/readme?v=v2)를 참고하세요
+ */
+export type PayMethod = PaymentPayMethod;

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

@@ -0,0 +1,191 @@
+import { Currency } from './Currency.js';
+/**
+ * **결제 통화**
+ *
+ * 원화 결제 시 `KRW`입니다.
+ */
+export declare const PaymentCurrency: {
+    readonly KRW: "KRW";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly JPY: "JPY";
+    readonly CNY: "CNY";
+    readonly VND: "VND";
+    readonly THB: "THB";
+    readonly SGD: "SGD";
+    readonly AUD: "AUD";
+    readonly HKD: "HKD";
+    readonly AED: "AED";
+    readonly AFN: "AFN";
+    readonly ALL: "ALL";
+    readonly AMD: "AMD";
+    readonly ANG: "ANG";
+    readonly AOA: "AOA";
+    readonly ARS: "ARS";
+    readonly AWG: "AWG";
+    readonly AZN: "AZN";
+    readonly BAM: "BAM";
+    readonly BBD: "BBD";
+    readonly BDT: "BDT";
+    readonly BGN: "BGN";
+    readonly BMD: "BMD";
+    readonly BND: "BND";
+    readonly BOB: "BOB";
+    readonly BOV: "BOV";
+    readonly BRL: "BRL";
+    readonly BSD: "BSD";
+    readonly BWP: "BWP";
+    readonly BYN: "BYN";
+    readonly BZD: "BZD";
+    readonly CAD: "CAD";
+    readonly CDF: "CDF";
+    readonly CHE: "CHE";
+    readonly CHF: "CHF";
+    readonly CHW: "CHW";
+    readonly CLF: "CLF";
+    readonly CLP: "CLP";
+    readonly COP: "COP";
+    readonly COU: "COU";
+    readonly CRC: "CRC";
+    readonly CUC: "CUC";
+    readonly CUP: "CUP";
+    readonly CVE: "CVE";
+    readonly CZK: "CZK";
+    readonly DJF: "DJF";
+    readonly DKK: "DKK";
+    readonly DOP: "DOP";
+    readonly DZD: "DZD";
+    readonly EGP: "EGP";
+    readonly ERN: "ERN";
+    readonly ETB: "ETB";
+    readonly FJD: "FJD";
+    readonly FKP: "FKP";
+    readonly GBP: "GBP";
+    readonly GEL: "GEL";
+    readonly GHS: "GHS";
+    readonly GIP: "GIP";
+    readonly GMD: "GMD";
+    readonly GNF: "GNF";
+    readonly GTQ: "GTQ";
+    readonly GYD: "GYD";
+    readonly HNL: "HNL";
+    readonly HRK: "HRK";
+    readonly HTG: "HTG";
+    readonly HUF: "HUF";
+    readonly IDR: "IDR";
+    readonly ILS: "ILS";
+    readonly INR: "INR";
+    readonly IQD: "IQD";
+    readonly IRR: "IRR";
+    readonly ISK: "ISK";
+    readonly JMD: "JMD";
+    readonly JOD: "JOD";
+    readonly KES: "KES";
+    readonly KGS: "KGS";
+    readonly KHR: "KHR";
+    readonly KMF: "KMF";
+    readonly KPW: "KPW";
+    readonly KWD: "KWD";
+    readonly KYD: "KYD";
+    readonly KZT: "KZT";
+    readonly LAK: "LAK";
+    readonly LBP: "LBP";
+    readonly LKR: "LKR";
+    readonly LRD: "LRD";
+    readonly LSL: "LSL";
+    readonly LYD: "LYD";
+    readonly MAD: "MAD";
+    readonly MDL: "MDL";
+    readonly MGA: "MGA";
+    readonly MKD: "MKD";
+    readonly MMK: "MMK";
+    readonly MNT: "MNT";
+    readonly MOP: "MOP";
+    readonly MRU: "MRU";
+    readonly MUR: "MUR";
+    readonly MVR: "MVR";
+    readonly MWK: "MWK";
+    readonly MXN: "MXN";
+    readonly MXV: "MXV";
+    readonly MZN: "MZN";
+    readonly NAD: "NAD";
+    readonly NGN: "NGN";
+    readonly NIO: "NIO";
+    readonly NOK: "NOK";
+    readonly NPR: "NPR";
+    readonly NZD: "NZD";
+    readonly OMR: "OMR";
+    readonly PAB: "PAB";
+    readonly PEN: "PEN";
+    readonly PGK: "PGK";
+    readonly PHP: "PHP";
+    readonly PKR: "PKR";
+    readonly PLN: "PLN";
+    readonly PYG: "PYG";
+    readonly QAR: "QAR";
+    readonly RON: "RON";
+    readonly RSD: "RSD";
+    readonly RUB: "RUB";
+    readonly RWF: "RWF";
+    readonly SAR: "SAR";
+    readonly SBD: "SBD";
+    readonly SCR: "SCR";
+    readonly SDG: "SDG";
+    readonly SEK: "SEK";
+    readonly SHP: "SHP";
+    readonly SLE: "SLE";
+    readonly SLL: "SLL";
+    readonly SOS: "SOS";
+    readonly SRD: "SRD";
+    readonly SSP: "SSP";
+    readonly STN: "STN";
+    readonly SVC: "SVC";
+    readonly SYP: "SYP";
+    readonly SZL: "SZL";
+    readonly TJS: "TJS";
+    readonly TMT: "TMT";
+    readonly TND: "TND";
+    readonly TOP: "TOP";
+    readonly TRY: "TRY";
+    readonly TTD: "TTD";
+    readonly TWD: "TWD";
+    readonly TZS: "TZS";
+    readonly UAH: "UAH";
+    readonly UGX: "UGX";
+    readonly USN: "USN";
+    readonly UYI: "UYI";
+    readonly UYU: "UYU";
+    readonly UYW: "UYW";
+    readonly UZS: "UZS";
+    readonly VED: "VED";
+    readonly VES: "VES";
+    readonly VUV: "VUV";
+    readonly WST: "WST";
+    readonly XAF: "XAF";
+    readonly XAG: "XAG";
+    readonly XAU: "XAU";
+    readonly XBA: "XBA";
+    readonly XBB: "XBB";
+    readonly XBC: "XBC";
+    readonly XBD: "XBD";
+    readonly XCD: "XCD";
+    readonly XDR: "XDR";
+    readonly XOF: "XOF";
+    readonly XPD: "XPD";
+    readonly XPF: "XPF";
+    readonly XPT: "XPT";
+    readonly XSU: "XSU";
+    readonly XTS: "XTS";
+    readonly XUA: "XUA";
+    readonly XXX: "XXX";
+    readonly YER: "YER";
+    readonly ZAR: "ZAR";
+    readonly ZMW: "ZMW";
+    readonly ZWL: "ZWL";
+};
+/**
+ * **결제 통화**
+ *
+ * 원화 결제 시 `KRW`입니다.
+ */
+export type PaymentCurrency = Currency;

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

@@ -0,0 +1,4 @@
+/**
+ * **주문명**
+ */
+export type PaymentOrderName = string;

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

@@ -0,0 +1,53 @@
+/**
+ * **결제수단 구분코드**
+ *
+ * PG사별 지원되는 결제수단이 모두 상이합니다.
+ *
+ * [각 PG사별 결제 연동 가이드](https://developers.portone.io/opi/ko/integration/pg/v2/readme?v=v2)를 참고하세요
+ */
+export declare const PaymentPayMethod: {
+    /**
+     * 카드
+     */
+    readonly CARD: "CARD";
+    /**
+     * 가상계좌
+     */
+    readonly VIRTUAL_ACCOUNT: "VIRTUAL_ACCOUNT";
+    /**
+     * 계좌이체
+     */
+    readonly TRANSFER: "TRANSFER";
+    /**
+     * 휴대폰 소액결제
+     */
+    readonly MOBILE: "MOBILE";
+    /**
+     * 상품권
+     */
+    readonly GIFT_CERTIFICATE: "GIFT_CERTIFICATE";
+    /**
+     * 간편 결제
+     */
+    readonly EASY_PAY: "EASY_PAY";
+    /**
+     * 페이팔(SPB)
+     */
+    readonly PAYPAL: "PAYPAL";
+    /**
+     * 알리페이
+     */
+    readonly ALIPAY: "ALIPAY";
+    /**
+     * 편의점 결제
+     */
+    readonly CONVENIENCE_STORE: "CONVENIENCE_STORE";
+};
+/**
+ * **결제수단 구분코드**
+ *
+ * PG사별 지원되는 결제수단이 모두 상이합니다.
+ *
+ * [각 PG사별 결제 연동 가이드](https://developers.portone.io/opi/ko/integration/pg/v2/readme?v=v2)를 참고하세요
+ */
+export type PaymentPayMethod = (typeof PaymentPayMethod)[keyof typeof PaymentPayMethod];

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

@@ -0,0 +1,14 @@
+/**
+ * **결제 금액**
+ *
+ * 결제 금액을 정수로 나타냅니다.
+ *
+ * 해외 통화의 경우 통화의 최소 단위(minor unit)를 기준으로 합니다. 예를 들어, USD의 최소 단위는 센트(0.01 USD)이므로, 6 USD의 경우 100배하여 600으로 입력합니다.
+ *
+ * 최소 단위는 [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html)에 표준화된 것을 기준으로 합니다.
+ *
+ * - KRW: 1배
+ * - USD: 100배
+ * - JPY: 1배
+ */
+export type PaymentTotalAmount = number;

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

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

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

@@ -0,0 +1,6 @@
+/**
+ * **PG 오류 코드**
+ *
+ * PG에서 오류 코드를 내려 주는 경우 이 오류 코드를 그대로 반환합니다.
+ */
+export type PgCode = string;

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

@@ -0,0 +1,6 @@
+/**
+ * **PG 오류 메시지**
+ *
+ * PG에서 오류 메시지를 내려 주는 경우 이 오류 메시지를 그대로 반환합니다.
+ */
+export type PgMessage = string;

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

@@ -1,98 +1,53 @@
+/**
+ * **PG사 구분코드**
+ */
 export declare const PgProvider: {
-    readonly HTML5_INICIS: "PG_PROVIDER_HTML5_INICIS";
-    readonly PAYPAL: "PG_PROVIDER_PAYPAL";
-    readonly INICIS: "PG_PROVIDER_INICIS";
-    readonly DANAL: "PG_PROVIDER_DANAL";
-    readonly NICE: "PG_PROVIDER_NICE";
-    readonly DANAL_TPAY: "PG_PROVIDER_DANAL_TPAY";
-    readonly UPLUS: "PG_PROVIDER_UPLUS";
-    readonly NAVERPAY: "PG_PROVIDER_NAVERPAY";
-    readonly SETTLE: "PG_PROVIDER_SETTLE";
-    readonly KCP: "PG_PROVIDER_KCP";
-    readonly MOBILIANS: "PG_PROVIDER_MOBILIANS";
-    readonly KAKAOPAY: "PG_PROVIDER_KAKAOPAY";
-    readonly NAVERCO: "PG_PROVIDER_NAVERCO";
-    readonly KICC: "PG_PROVIDER_KICC";
-    readonly EXIMBAY: "PG_PROVIDER_EXIMBAY";
-    readonly SMILEPAY: "PG_PROVIDER_SMILEPAY";
-    readonly PAYCO: "PG_PROVIDER_PAYCO";
-    readonly KCP_BILLING: "PG_PROVIDER_KCP_BILLING";
-    readonly ALIPAY: "PG_PROVIDER_ALIPAY";
-    readonly CHAI: "PG_PROVIDER_CHAI";
-    readonly BLUEWALNUT: "PG_PROVIDER_BLUEWALNUT";
-    readonly SMARTRO: "PG_PROVIDER_SMARTRO";
-    readonly PAYMENTWALL: "PG_PROVIDER_PAYMENTWALL";
-    readonly TOSSPAYMENTS: "PG_PROVIDER_TOSSPAYMENTS";
-    readonly KCP_QUICK: "PG_PROVIDER_KCP_QUICK";
-    readonly DAOU: "PG_PROVIDER_DAOU";
-    readonly GALAXIA: "PG_PROVIDER_GALAXIA";
-    readonly TOSSPAY: "PG_PROVIDER_TOSSPAY";
-    readonly KCP_DIRECT: "PG_PROVIDER_KCP_DIRECT";
-    readonly SETTLE_ACC: "PG_PROVIDER_SETTLE_ACC";
-    readonly SETTLE_FIRM: "PG_PROVIDER_SETTLE_FIRM";
-    readonly INICIS_UNIFIED: "PG_PROVIDER_INICIS_UNIFIED";
-    readonly KSNET: "PG_PROVIDER_KSNET";
-    readonly PAYPAL_V2: "PG_PROVIDER_PAYPAL_V2";
-    readonly SMARTRO_V2: "PG_PROVIDER_SMARTRO_V2";
-    readonly NICE_V2: "PG_PROVIDER_NICE_V2";
-    readonly TOSS_BRANDPAY: "PG_PROVIDER_TOSS_BRANDPAY";
-    readonly WELCOME: "PG_PROVIDER_WELCOME";
-    readonly TOSSPAY_V2: "PG_PROVIDER_TOSSPAY_V2";
-    readonly INICIS_V2: "PG_PROVIDER_INICIS_V2";
-    readonly KPN: "PG_PROVIDER_KPN";
-    readonly KCP_V2: "PG_PROVIDER_KCP_V2";
-    readonly HYPHEN: "PG_PROVIDER_HYPHEN";
-    readonly EXIMBAY_V2: "PG_PROVIDER_EXIMBAY_V2";
+    readonly HTML5_INICIS: "HTML5_INICIS";
+    readonly PAYPAL: "PAYPAL";
+    readonly INICIS: "INICIS";
+    readonly DANAL: "DANAL";
+    readonly NICE: "NICE";
+    readonly DANAL_TPAY: "DANAL_TPAY";
+    readonly UPLUS: "UPLUS";
+    readonly NAVERPAY: "NAVERPAY";
+    readonly SETTLE: "SETTLE";
+    readonly KCP: "KCP";
+    readonly MOBILIANS: "MOBILIANS";
+    readonly KAKAOPAY: "KAKAOPAY";
+    readonly NAVERCO: "NAVERCO";
+    readonly KICC: "KICC";
+    readonly EXIMBAY: "EXIMBAY";
+    readonly SMILEPAY: "SMILEPAY";
+    readonly PAYCO: "PAYCO";
+    readonly KCP_BILLING: "KCP_BILLING";
+    readonly ALIPAY: "ALIPAY";
+    readonly CHAI: "CHAI";
+    readonly BLUEWALNUT: "BLUEWALNUT";
+    readonly SMARTRO: "SMARTRO";
+    readonly PAYMENTWALL: "PAYMENTWALL";
+    readonly TOSSPAYMENTS: "TOSSPAYMENTS";
+    readonly KCP_QUICK: "KCP_QUICK";
+    readonly DAOU: "DAOU";
+    readonly GALAXIA: "GALAXIA";
+    readonly TOSSPAY: "TOSSPAY";
+    readonly KCP_DIRECT: "KCP_DIRECT";
+    readonly SETTLE_ACC: "SETTLE_ACC";
+    readonly SETTLE_FIRM: "SETTLE_FIRM";
+    readonly INICIS_UNIFIED: "INICIS_UNIFIED";
+    readonly KSNET: "KSNET";
+    readonly PAYPAL_V2: "PAYPAL_V2";
+    readonly SMARTRO_V2: "SMARTRO_V2";
+    readonly NICE_V2: "NICE_V2";
+    readonly TOSS_BRANDPAY: "TOSS_BRANDPAY";
+    readonly WELCOME: "WELCOME";
+    readonly TOSSPAY_V2: "TOSSPAY_V2";
+    readonly INICIS_V2: "INICIS_V2";
+    readonly KPN: "KPN";
+    readonly KCP_V2: "KCP_V2";
+    readonly HYPHEN: "HYPHEN";
+    readonly EXIMBAY_V2: "EXIMBAY_V2";
 };
-export type PgProvider = typeof PgProvider[keyof typeof PgProvider];
-type InversionMap<T extends Record<keyof T, keyof any>> = {
-    [K in keyof T as T[K]]: K;
-};
-export declare const InversionPgProvider: InversionMap<{
-    readonly HTML5_INICIS: "PG_PROVIDER_HTML5_INICIS";
-    readonly PAYPAL: "PG_PROVIDER_PAYPAL";
-    readonly INICIS: "PG_PROVIDER_INICIS";
-    readonly DANAL: "PG_PROVIDER_DANAL";
-    readonly NICE: "PG_PROVIDER_NICE";
-    readonly DANAL_TPAY: "PG_PROVIDER_DANAL_TPAY";
-    readonly UPLUS: "PG_PROVIDER_UPLUS";
-    readonly NAVERPAY: "PG_PROVIDER_NAVERPAY";
-    readonly SETTLE: "PG_PROVIDER_SETTLE";
-    readonly KCP: "PG_PROVIDER_KCP";
-    readonly MOBILIANS: "PG_PROVIDER_MOBILIANS";
-    readonly KAKAOPAY: "PG_PROVIDER_KAKAOPAY";
-    readonly NAVERCO: "PG_PROVIDER_NAVERCO";
-    readonly KICC: "PG_PROVIDER_KICC";
-    readonly EXIMBAY: "PG_PROVIDER_EXIMBAY";
-    readonly SMILEPAY: "PG_PROVIDER_SMILEPAY";
-    readonly PAYCO: "PG_PROVIDER_PAYCO";
-    readonly KCP_BILLING: "PG_PROVIDER_KCP_BILLING";
-    readonly ALIPAY: "PG_PROVIDER_ALIPAY";
-    readonly CHAI: "PG_PROVIDER_CHAI";
-    readonly BLUEWALNUT: "PG_PROVIDER_BLUEWALNUT";
-    readonly SMARTRO: "PG_PROVIDER_SMARTRO";
-    readonly PAYMENTWALL: "PG_PROVIDER_PAYMENTWALL";
-    readonly TOSSPAYMENTS: "PG_PROVIDER_TOSSPAYMENTS";
-    readonly KCP_QUICK: "PG_PROVIDER_KCP_QUICK";
-    readonly DAOU: "PG_PROVIDER_DAOU";
-    readonly GALAXIA: "PG_PROVIDER_GALAXIA";
-    readonly TOSSPAY: "PG_PROVIDER_TOSSPAY";
-    readonly KCP_DIRECT: "PG_PROVIDER_KCP_DIRECT";
-    readonly SETTLE_ACC: "PG_PROVIDER_SETTLE_ACC";
-    readonly SETTLE_FIRM: "PG_PROVIDER_SETTLE_FIRM";
-    readonly INICIS_UNIFIED: "PG_PROVIDER_INICIS_UNIFIED";
-    readonly KSNET: "PG_PROVIDER_KSNET";
-    readonly PAYPAL_V2: "PG_PROVIDER_PAYPAL_V2";
-    readonly SMARTRO_V2: "PG_PROVIDER_SMARTRO_V2";
-    readonly NICE_V2: "PG_PROVIDER_NICE_V2";
-    readonly TOSS_BRANDPAY: "PG_PROVIDER_TOSS_BRANDPAY";
-    readonly WELCOME: "PG_PROVIDER_WELCOME";
-    readonly TOSSPAY_V2: "PG_PROVIDER_TOSSPAY_V2";
-    readonly INICIS_V2: "PG_PROVIDER_INICIS_V2";
-    readonly KPN: "PG_PROVIDER_KPN";
-    readonly KCP_V2: "PG_PROVIDER_KCP_V2";
-    readonly HYPHEN: "PG_PROVIDER_HYPHEN";
-    readonly EXIMBAY_V2: "PG_PROVIDER_EXIMBAY_V2";
-}>;
-export type InversionPgProvider = typeof InversionPgProvider[keyof typeof InversionPgProvider];
-export {};
+/**
+ * **PG사 구분코드**
+ */
+export type PgProvider = (typeof PgProvider)[keyof typeof PgProvider] | `PG_PROVIDER_${(typeof PgProvider)[keyof typeof PgProvider]}`;

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

@@ -1,3 +1,12 @@
+/**
+ * **팝업 관련 필드**
+ *
+ * UI가 팝업 창으로 열릴 때 적용되는 속성입니다.
+ */
 export type Popup = {
-    center?: boolean;
+    /**
+     * **팝업 정중앙 표시**
+     * `true`로 설정하면 팝업이 브라우저 화면의 정중앙에 표시됩니다. 결제사 및 환경에 따라 적용되지 않을 수 있습니다.
+     */
+    center?: boolean | undefined;
 };

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

@@ -1,9 +1,42 @@
+/**
+ * **구매 상품 상세 정보**
+ */
 export type Product = {
+    /**
+     * **상품 ID**
+     */
     id: string;
+    /**
+     * **상품명**
+     */
     name: string;
-    code?: string;
+    /**
+     * **상품 코드**
+     *
+     * - 토스페이먼츠의 경우 필수로 입력해주세요.
+     */
+    code?: string | undefined;
+    /**
+     * **상품 단위 가격**
+     *
+     * 결제를 원하는 통화(currency)별 scale factor(소수점 몇번째 자리까지 유효한지)를 고려한 number 형식만 허용됩니다.
+     *
+     * - 1000 만큼 원화(KRW) 결제를 하는 경우, scale factor가 0이기 때문에 **1000 \* (10의 0승) = 1000**을 전달해야 합니다.
+     * - 1.50 만큼 달러(USD) 결제를 하는 경우, scale factor가 2이기 때문에 **1.50 \* (10의 2승) = 150**을 전달해야 합니다.
+     *
+     * 이렇게 전달 된 값은 실제로 PG사에 결제를 요청할때 currency에 따라 올바른 값으로 변환되기 때문에 반드시 currency값을 필수로 입력해야 합니다.
+     */
     amount: number;
+    /**
+     * **상품 수량**
+     */
     quantity: number;
-    tag?: string;
-    link?: string;
+    /**
+     * **상품 태그**
+     */
+    tag?: string | undefined;
+    /**
+     * **상품 판매 URL**
+     */
+    link?: string | undefined;
 };

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

@@ -1,10 +1,17 @@
 /**
- * 상품 유형. 대개 휴대폰 소액결제시 필수 입력으로 사용 됨
- * - REAL: 실물
- * - DIGITAL: 컨텐츠
+ * **상품 유형**
  */
 export declare const ProductType: {
-    readonly REAL: "PRODUCT_TYPE_REAL";
-    readonly DIGITAL: "PRODUCT_TYPE_DIGITAL";
+    /**
+     * 실물
+     */
+    readonly REAL: "REAL";
+    /**
+     * 디지털
+     */
+    readonly DIGITAL: "DIGITAL";
 };
-export type ProductType = typeof ProductType[keyof typeof ProductType];
+/**
+ * **상품 유형**
+ */
+export type ProductType = (typeof ProductType)[keyof typeof ProductType] | `PRODUCT_TYPE_${(typeof ProductType)[keyof typeof ProductType]}`;

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

@@ -0,0 +1,6 @@
+/**
+ * **리디렉션 방식에서 결제 완료 후 이동할 URL**
+ *
+ * 결제사 페이지로 이동하여 진행하는 리디렉션 방식의 경우 필수로 설정해야 합니다. 대부분의 모바일 환경이 리디렉션 방식에 해당됩니다.
+ */
+export type RedirectUrl = string;