@chevre/factory 4.347.0-alpha.8 → 4.347.0

package/lib/action/trade/pay.d.ts

@@ -87,7 +87,7 @@ export interface IPaymentService {
     paymentMethod: IPaymentMethod;
     pendingTransaction?: IPendingTransaction;
     /**
-     * ムビチケリスト
+     * 決済カードリスト
      */
     movieTickets?: IMovieTicket[];
     /**

package/lib/assetTransaction/pay.d.ts

@@ -63,7 +63,7 @@ export interface IPaymentMethod {
      */
     fromLocation?: IFromLocation;
     /**
-     * ムビチケリスト
+     * 決済カードリスト
      */
     movieTickets?: IMovieTicket[];
     /**

package/lib/categoryCode.d.ts

@@ -25,7 +25,7 @@ export declare enum CategorySetIdentifier {
      */
     MembershipType = "MembershipType",
     /**
-     * 決済カード(ムビチケ券種)区分
+     * 決済カード区分
      */
     MovieTicketType = "MovieTicketType",
     /**

package/lib/categoryCode.js

@@ -24,7 +24,7 @@ var CategorySetIdentifier;
      */
     CategorySetIdentifier["MembershipType"] = "MembershipType";
     /**
-     * 決済カード(ムビチケ券種)区分
+     * 決済カード区分
      */
     CategorySetIdentifier["MovieTicketType"] = "MovieTicketType";
     /**

package/lib/offer.d.ts

@@ -103,6 +103,7 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
     id?: string;
     /**
      * The payment method(s) accepted by seller for this offer.
+     * 対応決済方法区分
      */
     acceptedPaymentMethod?: IAcceptedPaymentMethod[];
     /**
@@ -124,15 +125,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;
-    /**
-     * 有効な顧客タイプ
-     */
     /**
      * 有効なメンバーシップタイプ
      */
@@ -190,10 +190,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;
     /**

package/lib/offerCatalog.d.ts

@@ -49,17 +49,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;
 }

package/lib/order.d.ts

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

package/lib/priceSpecification/unitPriceSpecification.d.ts

@@ -23,15 +23,16 @@ export interface IAppliesToAddOn {
  * 単価仕様
  */
 export interface IPriceSpecification extends Pick<BaseSpecification<PriceSpecificationType.UnitPriceSpecification>, 'project' | 'id' | 'typeOf' | 'name' | 'price' | 'priceCurrency' | 'valueAddedTaxIncluded' | 'accounting' | 'eligibleQuantity' | 'eligibleTransactionVolume'> {
+    /**
+     * 発生金額
+     */
     price: number;
     /**
      * 基準数量
      */
     referenceQuantity: IReferenceQuantity;
     /**
-     * 適用MovieTicket
-     * 複数決済カード対応(2022-07-11~)
-     * Arrayに完全限定(2023-09-01~)
+     * 適用決済カード
      */
     appliesToMovieTicket?: IAppliesToMovieTicket[];
     /**

package/lib/priceSpecificationType.d.ts

@@ -7,7 +7,7 @@ export declare enum PriceSpecificationType {
      */
     PriceSpecification = "PriceSpecification",
     /**
-     * カテゴリーコードチャージ仕様
+     * 区分加算料金
      */
     CategoryCodeChargeSpecification = "CategoryCodeChargeSpecification",
     /**
@@ -15,7 +15,7 @@ export declare enum PriceSpecificationType {
      */
     CompoundPriceSpecification = "CompoundPriceSpecification",
     /**
-     * ムビチケ券種区分チャージ仕様
+     * 決済カード加算料金
      */
     MovieTicketTypeChargeSpecification = "MovieTicketTypeChargeSpecification",
     /**

package/lib/priceSpecificationType.js

@@ -11,7 +11,7 @@ var PriceSpecificationType;
      */
     PriceSpecificationType["PriceSpecification"] = "PriceSpecification";
     /**
-     * カテゴリーコードチャージ仕様
+     * 区分加算料金
      */
     PriceSpecificationType["CategoryCodeChargeSpecification"] = "CategoryCodeChargeSpecification";
     /**
@@ -19,7 +19,7 @@ var PriceSpecificationType;
      */
     PriceSpecificationType["CompoundPriceSpecification"] = "CompoundPriceSpecification";
     /**
-     * ムビチケ券種区分チャージ仕様
+     * 決済カード加算料金
      */
     PriceSpecificationType["MovieTicketTypeChargeSpecification"] = "MovieTicketTypeChargeSpecification";
     /**

package/lib/product.d.ts

@@ -2,12 +2,12 @@ import { ICategoryCode } from './categoryCode';
 import { IMultilingualString } from './multilingualString';
 import { IName as IOfferName, IOffer as IBaseOffer } from './offer';
 import { OfferType } from './offerType';
-import { IPermit } from './permit';
+import { IAmount as IPermitAmount, IPermit } from './permit';
 import { IPriceSpecification as ICategoryCodeChargeSpecification } from './priceSpecification/categoryCodeChargeSpecification';
 import { IPriceSpecification as ICompoundPriceSpecification } from './priceSpecification/compoundPriceSpecification';
 import { IPriceSpecification as IMovieTicketTypeChargeSpecification } from './priceSpecification/movieTicketTypeChargeSpecification';
 import { IPriceSpecification as IUnitPriceSpecification } from './priceSpecification/unitPriceSpecification';
-import { IProject } from './project';
+import { IOnPaymentStatusChanged, IProject } from './project';
 import { IPropertyValue } from './propertyValue';
 import { IQuantitativeValue } from './quantitativeValue';
 import { SortType } from './sortType';
@@ -43,10 +43,11 @@ export interface IHasOfferCatalog {
     typeOf: 'OfferCatalog';
     id: string;
 }
-export type IMembershipPointsEarned = Pick<IQuantitativeValue<string>, 'name' | 'typeOf' | 'unitText' | 'value'>;
-export type IServiceOutput = Pick<IPermit, 'typeOf' | 'amount'> & {
-    membershipPointsEarned?: IMembershipPointsEarned;
-    automaticRenewal?: boolean;
+export type IServiceOutput = Pick<IPermit, 'typeOf'> & {
+    /**
+     * ペイメントカードの場合、通貨区分
+     */
+    amount?: Pick<IPermitAmount, 'currency' | 'typeOf'>;
 };
 /**
  * 外部サービス認証情報
@@ -62,6 +63,7 @@ export interface IAvailableChannel {
     typeOf: 'ServiceChannel';
     serviceUrl?: string;
     credentials?: ICredentials;
+    onPaymentStatusChanged?: IOnPaymentStatusChanged;
 }
 export type IServiceType = Pick<ICategoryCode, 'codeValue' | 'inCodeSet' | 'typeOf'>;
 export type IOffer = Pick<IBaseOffer, 'typeOf' | 'priceCurrency' | 'availabilityEnds' | 'availabilityStarts' | 'validFrom' | 'validThrough'> & {
@@ -78,18 +80,22 @@ export interface IProduct extends Pick<IThing, 'name' | 'description'> {
     typeOf: ProductType;
     id?: string;
     availableChannel?: IAvailableChannel;
-    description?: IMultilingualString;
+    /**
+     * 説明
+     */
+    description?: Pick<IMultilingualString, 'en' | 'ja'>;
     /**
      * Indicates an OfferCatalog listing for this Organization, Person, or Service.
+     * カタログ
      */
     hasOfferCatalog?: IHasOfferCatalog;
-    name?: IMultilingualString;
     /**
-     * An offer to provide this item
+     * 名称
      */
-    offers?: IOffer[];
+    name?: Pick<IMultilingualString, 'en' | 'ja'>;
     /**
      * The product identifier, such as ISBN. For example: meta itemprop="productID" content="isbn:123-456-789".
+     * プロジェクト内でユニークなプロダクトID
      */
     productID: string;
     /**
@@ -98,6 +104,7 @@ export interface IProduct extends Pick<IThing, 'name' | 'description'> {
     serviceOutput?: IServiceOutput;
     /**
      * The type of service being offered, e.g. veterans' benefits, emergency relief, etc.
+     * サービスタイプ(興行区分、メンバーシップ区分、決済方法区分)
      */
     serviceType?: IServiceType;
     additionalProperty?: IPropertyValue<string>[];
@@ -111,7 +118,7 @@ export type ICreateParams = Pick<IProduct, 'typeOf' | 'productID' | 'name' | 'de
         /**
          * カタログコードを指定する場合
          */
-        identifier: string;
+        identifier?: string;
     };
     /**
      * サービスタイプ

package/lib/service/paymentService.d.ts

@@ -1,7 +1,8 @@
 import { IInvoice } from '../invoice';
+import { IMultilingualString } from '../multilingualString';
 import { IIssuedThrough, IPermit } from '../permit';
 import { IAvailableChannel as IProductAvailableChannel, IServiceType } from '../product';
-import { IOnPaymentStatusChanged, IProject } from '../project';
+import { IProject } from '../project';
 import { IPropertyValue } from '../propertyValue';
 import { ISeller } from '../seller';
 import { IThing } from '../thing';
@@ -35,15 +36,15 @@ export interface IProviderCredentials {
     tokenizationCode?: string;
     paymentUrl?: IPaymentUrlSettings;
     /**
-     * ムビチケ興行会社コード
+     * 決済カード興行会社コード
      */
     kgygishCd?: string;
     /**
-     * ムビチケサイトコード
+     * 決済カードサイトコード
      */
     stCd?: string;
 }
-export interface IProvider extends Pick<ISeller, 'name' | 'typeOf'> {
+export interface IProvider extends Pick<ISeller, 'typeOf'> {
     /**
      * 販売者ID
      */
@@ -54,7 +55,6 @@ export interface IProvider extends Pick<ISeller, 'name' | 'typeOf'> {
     credentials?: IProviderCredentials;
 }
 export type IAvailableChannel = IProductAvailableChannel & {
-    onPaymentStatusChanged?: IOnPaymentStatusChanged;
     totalPaymentDue?: {
         maxValue?: number;
     };
@@ -100,15 +100,13 @@ export interface IService extends Pick<IThing, 'name' | 'description'> {
     typeOf: PaymentServiceType;
     id?: string;
     availableChannel?: IAvailableChannel;
+    description?: Pick<IMultilingualString, 'en' | 'ja'>;
+    name?: Pick<IMultilingualString, 'en' | 'ja'>;
     /**
      * The product identifier, such as ISBN.
-     * プロジェクト内でユニークな想定
+     * プロジェクト内でユニークなプロダクトID
      */
     productID: string;
-    /**
-     * 決済サービス提供者(決済サービスを利用する販売者)
-     */
-    provider?: IProvider[];
     /**
      * The tangible thing generated by the service, e.g. a passport, permit, etc.
      * (InvoiceやPermit)

package/lib/thing.d.ts

@@ -18,6 +18,7 @@ export interface IThing {
     color?: string;
     /**
      * A description of the item.
+     * 説明
      */
     description?: string | IMultilingualString;
     /**
@@ -30,6 +31,7 @@ export interface IThing {
     image?: string;
     /**
      * The name of the item.
+     * 名称
      */
     name?: string | IMultilingualString;
     sameAs?: string;

package/lib/transaction/returnOrder.d.ts

@@ -93,7 +93,7 @@ export interface IReturnOrderActionParams {
          */
         refundCreditCard?: IRefundParams[];
         /**
-         * ムビチケ着券取消を実行するかどうか
+         * 決済カード着券取消を実行するかどうか
          */
         /**
          * Eメール送信アクション

package/lib/unitPriceOffer.d.ts

@@ -48,6 +48,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'> {
@@ -67,18 +70,36 @@ export interface IUnitPriceOffer extends Pick<IOffer, 'acceptedPaymentMethod' |
      * コード
      */
     identifier: string;
+    /**
+     * 名称
+     */
     name: IName;
     /**
      * 単価仕様
      */
     priceSpecification: IUnitPriceOfferPriceSpecification;
+    /**
+     * プロダクト
+     */
     itemOffered?: IItemOffered;
+    /**
+     * アドオン
+     */
     addOn?: IAddOn4unitPriceOffer[];
     typeOf: OfferType.Offer;
+    /**
+     * 返品ポリシー
+     */
     hasMerchantReturnPolicy?: IHasMerchantReturnPolicy;
+    /**
+     * オプション
+     */
     settings?: ISettings;
 }
 export type ICreateParams = Pick<IUnitPriceOffer, 'acceptedPaymentMethod' | 'eligibleSubReservation' | 'additionalProperty' | 'alternateName' | 'availability' | 'availableAtOrFrom' | 'color' | 'description' | 'identifier' | 'itemOffered' | 'name' | 'settings' | 'validFrom' | 'validRateLimit' | 'validThrough'> & {
+    /**
+     * アドオン
+     */
     addOn?: {
         itemOffered: {
             /**
@@ -87,17 +108,29 @@ export type ICreateParams = Pick<IUnitPriceOffer, 'acceptedPaymentMethod' | 'eli
             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'> & {
         /**
          * 勘定内容

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chevre/factory",
-  "version": "4.347.0-alpha.8",
+  "version": "4.347.0",
   "description": "Chevre Factory Library for Javascript",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",