@portone/browser-sdk 0.0.22 → 0.0.24

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: "CURRENCY_KRW";
+    readonly USD: "CURRENCY_USD";
+    readonly EUR: "CURRENCY_EUR";
+    readonly JPY: "CURRENCY_JPY";
+    readonly CNY: "CURRENCY_CNY";
+    readonly VND: "CURRENCY_VND";
+    readonly THB: "CURRENCY_THB";
+    readonly SGD: "CURRENCY_SGD";
+    readonly AUD: "CURRENCY_AUD";
+    readonly HKD: "CURRENCY_HKD";
+    readonly AED: "CURRENCY_AED";
+    readonly AFN: "CURRENCY_AFN";
+    readonly ALL: "CURRENCY_ALL";
+    readonly AMD: "CURRENCY_AMD";
+    readonly ANG: "CURRENCY_ANG";
+    readonly AOA: "CURRENCY_AOA";
+    readonly ARS: "CURRENCY_ARS";
+    readonly AWG: "CURRENCY_AWG";
+    readonly AZN: "CURRENCY_AZN";
+    readonly BAM: "CURRENCY_BAM";
+    readonly BBD: "CURRENCY_BBD";
+    readonly BDT: "CURRENCY_BDT";
+    readonly BGN: "CURRENCY_BGN";
+    readonly BMD: "CURRENCY_BMD";
+    readonly BND: "CURRENCY_BND";
+    readonly BOB: "CURRENCY_BOB";
+    readonly BOV: "CURRENCY_BOV";
+    readonly BRL: "CURRENCY_BRL";
+    readonly BSD: "CURRENCY_BSD";
+    readonly BWP: "CURRENCY_BWP";
+    readonly BYN: "CURRENCY_BYN";
+    readonly BZD: "CURRENCY_BZD";
+    readonly CAD: "CURRENCY_CAD";
+    readonly CDF: "CURRENCY_CDF";
+    readonly CHE: "CURRENCY_CHE";
+    readonly CHF: "CURRENCY_CHF";
+    readonly CHW: "CURRENCY_CHW";
+    readonly CLF: "CURRENCY_CLF";
+    readonly CLP: "CURRENCY_CLP";
+    readonly COP: "CURRENCY_COP";
+    readonly COU: "CURRENCY_COU";
+    readonly CRC: "CURRENCY_CRC";
+    readonly CUC: "CURRENCY_CUC";
+    readonly CUP: "CURRENCY_CUP";
+    readonly CVE: "CURRENCY_CVE";
+    readonly CZK: "CURRENCY_CZK";
+    readonly DJF: "CURRENCY_DJF";
+    readonly DKK: "CURRENCY_DKK";
+    readonly DOP: "CURRENCY_DOP";
+    readonly DZD: "CURRENCY_DZD";
+    readonly EGP: "CURRENCY_EGP";
+    readonly ERN: "CURRENCY_ERN";
+    readonly ETB: "CURRENCY_ETB";
+    readonly FJD: "CURRENCY_FJD";
+    readonly FKP: "CURRENCY_FKP";
+    readonly GBP: "CURRENCY_GBP";
+    readonly GEL: "CURRENCY_GEL";
+    readonly GHS: "CURRENCY_GHS";
+    readonly GIP: "CURRENCY_GIP";
+    readonly GMD: "CURRENCY_GMD";
+    readonly GNF: "CURRENCY_GNF";
+    readonly GTQ: "CURRENCY_GTQ";
+    readonly GYD: "CURRENCY_GYD";
+    readonly HNL: "CURRENCY_HNL";
+    readonly HRK: "CURRENCY_HRK";
+    readonly HTG: "CURRENCY_HTG";
+    readonly HUF: "CURRENCY_HUF";
+    readonly IDR: "CURRENCY_IDR";
+    readonly ILS: "CURRENCY_ILS";
+    readonly INR: "CURRENCY_INR";
+    readonly IQD: "CURRENCY_IQD";
+    readonly IRR: "CURRENCY_IRR";
+    readonly ISK: "CURRENCY_ISK";
+    readonly JMD: "CURRENCY_JMD";
+    readonly JOD: "CURRENCY_JOD";
+    readonly KES: "CURRENCY_KES";
+    readonly KGS: "CURRENCY_KGS";
+    readonly KHR: "CURRENCY_KHR";
+    readonly KMF: "CURRENCY_KMF";
+    readonly KPW: "CURRENCY_KPW";
+    readonly KWD: "CURRENCY_KWD";
+    readonly KYD: "CURRENCY_KYD";
+    readonly KZT: "CURRENCY_KZT";
+    readonly LAK: "CURRENCY_LAK";
+    readonly LBP: "CURRENCY_LBP";
+    readonly LKR: "CURRENCY_LKR";
+    readonly LRD: "CURRENCY_LRD";
+    readonly LSL: "CURRENCY_LSL";
+    readonly LYD: "CURRENCY_LYD";
+    readonly MAD: "CURRENCY_MAD";
+    readonly MDL: "CURRENCY_MDL";
+    readonly MGA: "CURRENCY_MGA";
+    readonly MKD: "CURRENCY_MKD";
+    readonly MMK: "CURRENCY_MMK";
+    readonly MNT: "CURRENCY_MNT";
+    readonly MOP: "CURRENCY_MOP";
+    readonly MRU: "CURRENCY_MRU";
+    readonly MUR: "CURRENCY_MUR";
+    readonly MVR: "CURRENCY_MVR";
+    readonly MWK: "CURRENCY_MWK";
+    readonly MXN: "CURRENCY_MXN";
+    readonly MXV: "CURRENCY_MXV";
+    readonly MZN: "CURRENCY_MZN";
+    readonly NAD: "CURRENCY_NAD";
+    readonly NGN: "CURRENCY_NGN";
+    readonly NIO: "CURRENCY_NIO";
+    readonly NOK: "CURRENCY_NOK";
+    readonly NPR: "CURRENCY_NPR";
+    readonly NZD: "CURRENCY_NZD";
+    readonly OMR: "CURRENCY_OMR";
+    readonly PAB: "CURRENCY_PAB";
+    readonly PEN: "CURRENCY_PEN";
+    readonly PGK: "CURRENCY_PGK";
+    readonly PHP: "CURRENCY_PHP";
+    readonly PKR: "CURRENCY_PKR";
+    readonly PLN: "CURRENCY_PLN";
+    readonly PYG: "CURRENCY_PYG";
+    readonly QAR: "CURRENCY_QAR";
+    readonly RON: "CURRENCY_RON";
+    readonly RSD: "CURRENCY_RSD";
+    readonly RUB: "CURRENCY_RUB";
+    readonly RWF: "CURRENCY_RWF";
+    readonly SAR: "CURRENCY_SAR";
+    readonly SBD: "CURRENCY_SBD";
+    readonly SCR: "CURRENCY_SCR";
+    readonly SDG: "CURRENCY_SDG";
+    readonly SEK: "CURRENCY_SEK";
+    readonly SHP: "CURRENCY_SHP";
+    readonly SLE: "CURRENCY_SLE";
+    readonly SLL: "CURRENCY_SLL";
+    readonly SOS: "CURRENCY_SOS";
+    readonly SRD: "CURRENCY_SRD";
+    readonly SSP: "CURRENCY_SSP";
+    readonly STN: "CURRENCY_STN";
+    readonly SVC: "CURRENCY_SVC";
+    readonly SYP: "CURRENCY_SYP";
+    readonly SZL: "CURRENCY_SZL";
+    readonly TJS: "CURRENCY_TJS";
+    readonly TMT: "CURRENCY_TMT";
+    readonly TND: "CURRENCY_TND";
+    readonly TOP: "CURRENCY_TOP";
+    readonly TRY: "CURRENCY_TRY";
+    readonly TTD: "CURRENCY_TTD";
+    readonly TWD: "CURRENCY_TWD";
+    readonly TZS: "CURRENCY_TZS";
+    readonly UAH: "CURRENCY_UAH";
+    readonly UGX: "CURRENCY_UGX";
+    readonly USN: "CURRENCY_USN";
+    readonly UYI: "CURRENCY_UYI";
+    readonly UYU: "CURRENCY_UYU";
+    readonly UYW: "CURRENCY_UYW";
+    readonly UZS: "CURRENCY_UZS";
+    readonly VED: "CURRENCY_VED";
+    readonly VES: "CURRENCY_VES";
+    readonly VUV: "CURRENCY_VUV";
+    readonly WST: "CURRENCY_WST";
+    readonly XAF: "CURRENCY_XAF";
+    readonly XAG: "CURRENCY_XAG";
+    readonly XAU: "CURRENCY_XAU";
+    readonly XBA: "CURRENCY_XBA";
+    readonly XBB: "CURRENCY_XBB";
+    readonly XBC: "CURRENCY_XBC";
+    readonly XBD: "CURRENCY_XBD";
+    readonly XCD: "CURRENCY_XCD";
+    readonly XDR: "CURRENCY_XDR";
+    readonly XOF: "CURRENCY_XOF";
+    readonly XPD: "CURRENCY_XPD";
+    readonly XPF: "CURRENCY_XPF";
+    readonly XPT: "CURRENCY_XPT";
+    readonly XSU: "CURRENCY_XSU";
+    readonly XTS: "CURRENCY_XTS";
+    readonly XUA: "CURRENCY_XUA";
+    readonly XXX: "CURRENCY_XXX";
+    readonly YER: "CURRENCY_YER";
+    readonly ZAR: "CURRENCY_ZAR";
+    readonly ZMW: "CURRENCY_ZMW";
+    readonly ZWL: "CURRENCY_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,3 +1,6 @@
+/**
+ * **PG사 구분코드**
+ */
 export declare const PgProvider: {
     readonly HTML5_INICIS: "PG_PROVIDER_HTML5_INICIS";
     readonly PAYPAL: "PG_PROVIDER_PAYPAL";
@@ -44,55 +47,7 @@ export declare const PgProvider: {
     readonly HYPHEN: "PG_PROVIDER_HYPHEN";
     readonly EXIMBAY_V2: "PG_PROVIDER_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];

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";
 };
-export type ProductType = typeof ProductType[keyof typeof ProductType];
+/**
+ * **상품 유형**
+ */
+export type ProductType = (typeof ProductType)[keyof typeof ProductType];

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

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

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

@@ -1,25 +1,64 @@
+import type { StoreDetailsOpeningHours } from './StoreDetailsOpeningHours.js';
 /**
- * 상점 정보
+ * **상점 정보**
  *
- * KSNET 카카오페이의 경우 필수 입력
- * (신)나이스페이의 경우 매출 전표에 표기 할 용도로 선택 입력
- * 이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
+ * - KSNET 카카오페이의 경우 필수 입력
+ * - 나이스페이먼츠의 경우 매출 전표에 표기 할 용도로 선택 입력
+ * - KG이니시스 일본결제의 경우 JPPG(gmoPayment) 결제의 상점정보로 사용되거나 편의점 결제 시 영수증 표시 정보로 사용됨.
  */
 export type StoreDetails = {
-    ceoFullName?: string;
-    phoneNumber?: string;
-    address?: string;
-    zipcode?: string;
-    email?: string;
-    businessName?: string;
-    businessRegistrationNumber?: string;
-    storeName?: string;
-    storeNameShort?: string;
-    storeNameEn?: string;
-    storeNameKana?: string;
-    openingHours?: {
-        open?: string;
-        close?: string;
-    };
-    contactName?: string;
+    /**
+     * **대표자 이름**
+     */
+    ceoFullName?: string | undefined;
+    /**
+     * **전화번호**
+     */
+    phoneNumber?: string | undefined;
+    /**
+     * **주소**
+     */
+    address?: string | undefined;
+    /**
+     * 우편번호
+     */
+    zipcode?: string | undefined;
+    /**
+     * 이메일
+     */
+    email?: string | undefined;
+    /**
+     * **사업자명 (상호)**
+     */
+    businessName?: string | undefined;
+    /**
+     * **사업자 등록 번호**
+     */
+    businessRegistrationNumber?: string | undefined;
+    /**
+     * **상점명**
+     */
+    storeName?: string | undefined;
+    /**
+     * 상점명 약어
+     */
+    storeNameShort?: string | undefined;
+    /**
+     * 상점명 영문
+     */
+    storeNameEn?: string | undefined;
+    /**
+     * 상점명 후리카나 (일본어 읽는법 표기)
+     */
+    storeNameKana?: string | undefined;
+    /**
+     * 상점 영업시간 (HH:mm)
+     */
+    openingHours?: StoreDetailsOpeningHours | undefined;
+    /**
+     * **상점 연락처 정보 이름**
+     *
+     * ex: 문의창구, 연락처, 지원창구
+     */
+    contactName?: string | undefined;
 };

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

@@ -0,0 +1,13 @@
+/**
+ * 상점 영업시간 (HH:mm)
+ */
+export type StoreDetailsOpeningHours = {
+    /**
+     * 영업 시작 시간
+     */
+    open?: string | undefined;
+    /**
+     * 영업 종료 시간
+     */
+    close?: string | undefined;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * **상점 아이디**
+ *
+ * 포트원 계정에 생성된 상점을 식별하는 고유한 값으로 [관리자 콘솔 > 연동 정보](https://admin.portone.io/integration-v2/manage/channel) 우측 상단에서 확인할 수 있습니다.
+ */
+export type StoreId = string;

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

@@ -0,0 +1,6 @@
+/**
+ * **면세 금액**
+ *
+ * 미입력 시 0으로 취급됩니다.
+ */
+export type TaxFreeAmount = number;