コメント調整

chevre-jp · Dec 17, 2023 · f592a01 · f592a01
1 parent 34325f0
commit f592a01
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 19 deletions.
diff --git a/src/action/trade/pay.ts b/src/action/trade/pay.ts
@@ -89,7 +89,7 @@ export interface IPaymentService {
     paymentMethod: IPaymentMethod;
     pendingTransaction?: IPendingTransaction;
     /**
-     * ムビチケリスト
+     * 決済カードリスト
      */
     movieTickets?: IMovieTicket[];
     /**

diff --git a/src/assetTransaction/pay.ts b/src/assetTransaction/pay.ts
@@ -81,7 +81,7 @@ export interface IPaymentMethod {
      */
     fromLocation?: IFromLocation;
     /**
-     * ムビチケリスト
+     * 決済カードリスト
      */
     movieTickets?: IMovieTicket[];
     /**

diff --git a/src/categoryCode.ts b/src/categoryCode.ts
@@ -26,7 +26,7 @@ export enum CategorySetIdentifier {
      */
     MembershipType = 'MembershipType',
     /**
-     * 決済カード(ムビチケ券種)区分
+     * 決済カード区分
      */
     MovieTicketType = 'MovieTicketType',
     /**

diff --git a/src/offer.ts b/src/offer.ts
@@ -109,6 +109,7 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
     id?: string;
     /**
      * The payment method(s) accepted by seller for this offer.
+     * 対応決済方法区分
      */
     acceptedPaymentMethod?: IAcceptedPaymentMethod[];
     /**
@@ -130,15 +131,14 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
     availabilityStarts?: Date;
     /**
      * The place(s) from which the offer can be obtained (e.g. store locations).
+     * 利用可能アプリケーション
      */
     availableAtOrFrom?: IAvailableAtOrFrom[];
     /**
      * A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
+     * カテゴリー
      */
     category?: ICategory;
-    /**
-     * 有効な顧客タイプ
-     */
     // eligibleCustomerType?: any;
     /**
      * 有効なメンバーシップタイプ
@@ -197,10 +197,12 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
     unacceptedPaymentMethod?: string[];
     /**
      * The date when the item becomes valid.
+     * 有効期間(from)
      */
     validFrom?: Date;
     /**
      * The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
+     * 有効期間(through)
      */
     validThrough?: Date;
     /**

diff --git a/src/offerCatalog.ts b/src/offerCatalog.ts
@@ -50,17 +50,37 @@ export interface IRelatedOffer {
 /**
  * オファーカタログ
  */
-export interface IOfferCatalog extends Pick<IThing, 'name' | 'description' | 'alternateName'> {
+export interface IOfferCatalog extends Pick<IThing, 'name' | 'description'> {
     project: Pick<IProject, 'id' | 'typeOf'>;
     typeOf: OfferCatalogType;
     id?: string;
+    /**
+     * コード
+     */
     identifier: string;
+    /**
+     * 説明
+     */
+    description?: IMultilingualString;
+    /**
+     * 名称
+     */
     name: IMultilingualString;
+    /**
+     * アイテムリスト
+     */
     itemListElement: IItemListElement[];
+    /**
+     * プロダクト
+     */
     itemOffered: IItemOffered;
+    /**
+     * 追加特性
+     */
     additionalProperty?: IPropertyValue<string>[];
     /**
      * 関連オファー
+     * サブカタログの場合のみ存在
      */
     relatedOffer?: IRelatedOffer;
 }

diff --git a/src/order.ts b/src/order.ts
@@ -512,7 +512,7 @@ export interface ICustomerSearchConditions {
 export interface IPaymentMethodsSearchConditions {
     /**
      * 決済アカウントID
-     * ムビチケ購入番号、ペイメントカード番号など
+     * 決済カードコード、ペイメントカード番号など
      */
     accountIds?: string[];
     /**

diff --git a/src/priceSpecification/unitPriceSpecification.ts b/src/priceSpecification/unitPriceSpecification.ts
@@ -34,17 +34,18 @@ export interface IPriceSpecification extends Pick<
     | 'valueAddedTaxIncluded' | 'accounting'
     | 'eligibleQuantity' | 'eligibleTransactionVolume'
 > {
+    /**
+     * 発生金額
+     */
     price: number;
     /**
      * 基準数量
      */
     referenceQuantity: IReferenceQuantity;
     /**
-     * 適用MovieTicket
-     * 複数決済カード対応(2022-07-11~)
-     * Arrayに完全限定(2023-09-01~)
+     * 適用決済カード
      */
-    appliesToMovieTicket?: IAppliesToMovieTicket[];
+    appliesToMovieTicket?: IAppliesToMovieTicket[]; // Arrayに完全限定(2023-09-01~)
     /**
      * 適用アドオン
      * アドオンを指定された場合に適用される

diff --git a/src/priceSpecificationType.ts b/src/priceSpecificationType.ts
@@ -7,15 +7,15 @@ export enum PriceSpecificationType {
      */
     PriceSpecification = 'PriceSpecification',
     /**
-     * カテゴリーコードチャージ仕様
+     * 区分加算料金
      */
     CategoryCodeChargeSpecification = 'CategoryCodeChargeSpecification',
     /**
      * 複合価格仕様
      */
     CompoundPriceSpecification = 'CompoundPriceSpecification',
     /**
-     * ムビチケ券種区分チャージ仕様
+     * 決済カード加算料金
      */
     MovieTicketTypeChargeSpecification = 'MovieTicketTypeChargeSpecification',
     /**

diff --git a/src/service/paymentService.ts b/src/service/paymentService.ts
@@ -36,11 +36,11 @@ export interface IProviderCredentials {
     tokenizationCode?: string;
     paymentUrl?: IPaymentUrlSettings;
     /**
-     * ムビチケ興行会社コード
+     * 決済カード興行会社コード
      */
     kgygishCd?: string;
     /**
-     * ムビチケサイトコード
+     * 決済カードサイトコード
      */
     stCd?: string;
 }

diff --git a/src/thing.ts b/src/thing.ts
@@ -20,6 +20,7 @@ export interface IThing {
     color?: string;
     /**
      * A description of the item.
+     * 説明
      */
     description?: string | IMultilingualString;
     /**
@@ -32,6 +33,7 @@ export interface IThing {
     image?: string;
     /**
      * The name of the item.
+     * 名称
      */
     name?: string | IMultilingualString;
     sameAs?: string;

diff --git a/src/transaction/returnOrder.ts b/src/transaction/returnOrder.ts
@@ -97,7 +97,7 @@ export interface IReturnOrderActionParams {
         // chevre/apiへ移行できるか
         refundCreditCard?: IRefundParams[];
         /**
-         * ムビチケ着券取消を実行するかどうか
+         * 決済カード着券取消を実行するかどうか
          */
         // 廃止(2022-06-08~)
         // refundMovieTicket?: boolean;

diff --git a/src/unitPriceOffer.ts b/src/unitPriceOffer.ts
@@ -64,6 +64,9 @@ export interface IAddOn4unitPriceOffer extends Pick<IAddOn, 'typeOf' | 'priceCur
     itemOffered: IAddOnItemOffered;
 }
 export interface ISettings {
+    /**
+     * 区分加算料金を適用しない
+     */
     ignoreCategoryCodeChargeSpec?: boolean;
 }
 export interface IAdvanceBookingRequirement extends Pick<IQuantitativeValue<UnitCode.Sec>, 'typeOf' | 'minValue' | 'unitCode' | 'description'> {
@@ -91,17 +94,31 @@ export interface IUnitPriceOffer extends Pick<
      * コード
      */
     identifier: string;
+    /**
+     * 名称
+     */
     name: IName;
     /**
      * 単価仕様
      */
     priceSpecification: IUnitPriceOfferPriceSpecification;
+    /**
+     * プロダクト
+     */
     itemOffered?: IItemOffered;
+    /**
+     * アドオン
+     */
     addOn?: IAddOn4unitPriceOffer[];
     typeOf: OfferType.Offer;
+    /**
+     * 返品ポリシー
+     */
     hasMerchantReturnPolicy?: IHasMerchantReturnPolicy;
-    // settings追加(2023-01-26~)
-    settings?: ISettings;
+    /**
+     * オプション
+     */
+    settings?: ISettings; // settings追加(2023-01-26~)
 }
 export type ICreateParams = Pick<
     IUnitPriceOffer,
@@ -114,6 +131,9 @@ export type ICreateParams = Pick<
     | 'identifier' | 'itemOffered' | 'name'
     | 'settings' | 'validFrom' | 'validRateLimit' | 'validThrough'
 > & {
+    /**
+     * アドオン
+     */
     addOn?: {
         itemOffered: {
             /**
@@ -122,17 +142,29 @@ export type ICreateParams = Pick<
             id: string;
         };
     }[];
+    /**
+     * 事前予約要件
+     */
     advanceBookingRequirement?: Pick<IAdvanceBookingRequirement, 'description' | 'minValue'>;
+    /**
+     * カテゴリー
+     */
     category?: Pick<ICategory, 'codeValue'>;
     eligibleMembershipType?: Pick<IEligibleCategoryCode, 'codeValue'>[];
     eligibleMonetaryAmount?: Pick<IEligibleMonetaryAmount, 'currency' | 'value'>[];
     eligibleSeatingType?: Pick<IEligibleCategoryCode, 'codeValue'>[];
+    /**
+     * 返品ポリシー
+     */
     hasMerchantReturnPolicy?: {
         /**
          * 返品ポリシーコード
          */
         identifier: string;
     }[];
+    /**
+     * 価格仕様
+     */
     priceSpecification: Pick<
         IUnitPriceOfferPriceSpecification,
         'appliesToMovieTicket' | 'eligibleQuantity' | 'eligibleTransactionVolume' | 'price' | 'referenceQuantity'