@chevre/factory 4.347.0-alpha.1 → 4.347.0-alpha.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -87,7 +87,7 @@ export interface IPaymentService {
87
87
  paymentMethod: IPaymentMethod;
88
88
  pendingTransaction?: IPendingTransaction;
89
89
  /**
90
- * ムビチケリスト
90
+ * 決済カードリスト
91
91
  */
92
92
  movieTickets?: IMovieTicket[];
93
93
  /**
@@ -63,7 +63,7 @@ export interface IPaymentMethod {
63
63
  */
64
64
  fromLocation?: IFromLocation;
65
65
  /**
66
- * ムビチケリスト
66
+ * 決済カードリスト
67
67
  */
68
68
  movieTickets?: IMovieTicket[];
69
69
  /**
@@ -5,7 +5,7 @@ import { SortType } from './sortType';
5
5
  import { IThing } from './thing';
6
6
  export declare enum CategorySetIdentifier {
7
7
  /**
8
- * レーティングタイプ
8
+ * レイティング区分
9
9
  */
10
10
  ContentRatingType = "ContentRatingType",
11
11
  /**
@@ -25,7 +25,7 @@ export declare enum CategorySetIdentifier {
25
25
  */
26
26
  MembershipType = "MembershipType",
27
27
  /**
28
- * 決済カード(ムビチケ券種)区分
28
+ * 決済カード区分
29
29
  */
30
30
  MovieTicketType = "MovieTicketType",
31
31
  /**
@@ -4,7 +4,7 @@ exports.CategorySetIdentifier = void 0;
4
4
  var CategorySetIdentifier;
5
5
  (function (CategorySetIdentifier) {
6
6
  /**
7
- * レーティングタイプ
7
+ * レイティング区分
8
8
  */
9
9
  CategorySetIdentifier["ContentRatingType"] = "ContentRatingType";
10
10
  /**
@@ -24,7 +24,7 @@ var CategorySetIdentifier;
24
24
  */
25
25
  CategorySetIdentifier["MembershipType"] = "MembershipType";
26
26
  /**
27
- * 決済カード(ムビチケ券種)区分
27
+ * 決済カード区分
28
28
  */
29
29
  CategorySetIdentifier["MovieTicketType"] = "MovieTicketType";
30
30
  /**
@@ -38,6 +38,18 @@ export interface ICreativeWork extends Pick<CreativeWorkFactory.ICreativeWork, '
38
38
  distributor?: IDistributor;
39
39
  typeOf: CreativeWorkType.Movie;
40
40
  }
41
+ /**
42
+ * コンテンツ作成パラメータ
43
+ */
44
+ export type ICreateParams = Pick<ICreativeWork, 'additionalProperty' | 'datePublished' | 'duration' | 'headline' | 'identifier' | 'thumbnailUrl' | 'typeOf'> & {
45
+ name?: Pick<IMultilingualString, 'en' | 'ja'>;
46
+ offers: Pick<IOffer, 'availabilityEnds'>;
47
+ distributor?: Pick<IDistributor, 'codeValue'>;
48
+ /**
49
+ * レイティング区分コード
50
+ */
51
+ contentRating?: string;
52
+ };
41
53
  /**
42
54
  * ソート条件
43
55
  */
package/lib/offer.d.ts CHANGED
@@ -103,6 +103,7 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
103
103
  id?: string;
104
104
  /**
105
105
  * The payment method(s) accepted by seller for this offer.
106
+ * 対応決済方法区分
106
107
  */
107
108
  acceptedPaymentMethod?: IAcceptedPaymentMethod[];
108
109
  /**
@@ -124,15 +125,14 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
124
125
  availabilityStarts?: Date;
125
126
  /**
126
127
  * The place(s) from which the offer can be obtained (e.g. store locations).
128
+ * 利用可能アプリケーション
127
129
  */
128
130
  availableAtOrFrom?: IAvailableAtOrFrom[];
129
131
  /**
130
132
  * A category for the item. Greater signs or slashes can be used to informally indicate a category hierarchy.
133
+ * カテゴリー
131
134
  */
132
135
  category?: ICategory;
133
- /**
134
- * 有効な顧客タイプ
135
- */
136
136
  /**
137
137
  * 有効なメンバーシップタイプ
138
138
  */
@@ -190,10 +190,12 @@ export interface IOffer extends Pick<IThing, 'name' | 'description' | 'alternate
190
190
  unacceptedPaymentMethod?: string[];
191
191
  /**
192
192
  * The date when the item becomes valid.
193
+ * 有効期間(from)
193
194
  */
194
195
  validFrom?: Date;
195
196
  /**
196
197
  * The date after when the item is not valid. For example the end of an offer, salary period, or a period of opening hours.
198
+ * 有効期間(through)
197
199
  */
198
200
  validThrough?: Date;
199
201
  /**
@@ -49,17 +49,37 @@ export interface IRelatedOffer {
49
49
  /**
50
50
  * オファーカタログ
51
51
  */
52
- export interface IOfferCatalog extends Pick<IThing, 'name' | 'description' | 'alternateName'> {
52
+ export interface IOfferCatalog extends Pick<IThing, 'name' | 'description'> {
53
53
  project: Pick<IProject, 'id' | 'typeOf'>;
54
54
  typeOf: OfferCatalogType;
55
55
  id?: string;
56
+ /**
57
+ * コード
58
+ */
56
59
  identifier: string;
60
+ /**
61
+ * 説明
62
+ */
63
+ description?: IMultilingualString;
64
+ /**
65
+ * 名称
66
+ */
57
67
  name: IMultilingualString;
68
+ /**
69
+ * アイテムリスト
70
+ */
58
71
  itemListElement: IItemListElement[];
72
+ /**
73
+ * プロダクト
74
+ */
59
75
  itemOffered: IItemOffered;
76
+ /**
77
+ * 追加特性
78
+ */
60
79
  additionalProperty?: IPropertyValue<string>[];
61
80
  /**
62
81
  * 関連オファー
82
+ * サブカタログの場合のみ存在
63
83
  */
64
84
  relatedOffer?: IRelatedOffer;
65
85
  }
package/lib/order.d.ts CHANGED
@@ -448,7 +448,7 @@ export interface ICustomerSearchConditions {
448
448
  export interface IPaymentMethodsSearchConditions {
449
449
  /**
450
450
  * 決済アカウントID
451
- * ムビチケ購入番号、ペイメントカード番号など
451
+ * 決済カードコード、ペイメントカード番号など
452
452
  */
453
453
  accountIds?: string[];
454
454
  /**
@@ -23,15 +23,16 @@ export interface IAppliesToAddOn {
23
23
  * 単価仕様
24
24
  */
25
25
  export interface IPriceSpecification extends Pick<BaseSpecification<PriceSpecificationType.UnitPriceSpecification>, 'project' | 'id' | 'typeOf' | 'name' | 'price' | 'priceCurrency' | 'valueAddedTaxIncluded' | 'accounting' | 'eligibleQuantity' | 'eligibleTransactionVolume'> {
26
+ /**
27
+ * 発生金額
28
+ */
26
29
  price: number;
27
30
  /**
28
31
  * 基準数量
29
32
  */
30
33
  referenceQuantity: IReferenceQuantity;
31
34
  /**
32
- * 適用MovieTicket
33
- * 複数決済カード対応(2022-07-11~)
34
- * Arrayに完全限定(2023-09-01~)
35
+ * 適用決済カード
35
36
  */
36
37
  appliesToMovieTicket?: IAppliesToMovieTicket[];
37
38
  /**
@@ -12,9 +12,9 @@ import { UnitCode } from './unitCode';
12
12
  export interface IAccounting {
13
13
  typeOf: 'Accounting';
14
14
  /**
15
- * 営業収益
15
+ * 細目
16
16
  */
17
- operatingRevenue?: IAccountTitle;
17
+ operatingRevenue?: Pick<IAccountTitle, 'codeValue' | 'typeOf'>;
18
18
  /**
19
19
  * 売上金額
20
20
  */
@@ -7,7 +7,7 @@ export declare enum PriceSpecificationType {
7
7
  */
8
8
  PriceSpecification = "PriceSpecification",
9
9
  /**
10
- * カテゴリーコードチャージ仕様
10
+ * 区分加算料金
11
11
  */
12
12
  CategoryCodeChargeSpecification = "CategoryCodeChargeSpecification",
13
13
  /**
@@ -15,7 +15,7 @@ export declare enum PriceSpecificationType {
15
15
  */
16
16
  CompoundPriceSpecification = "CompoundPriceSpecification",
17
17
  /**
18
- * ムビチケ券種区分チャージ仕様
18
+ * 決済カード加算料金
19
19
  */
20
20
  MovieTicketTypeChargeSpecification = "MovieTicketTypeChargeSpecification",
21
21
  /**
@@ -11,7 +11,7 @@ var PriceSpecificationType;
11
11
  */
12
12
  PriceSpecificationType["PriceSpecification"] = "PriceSpecification";
13
13
  /**
14
- * カテゴリーコードチャージ仕様
14
+ * 区分加算料金
15
15
  */
16
16
  PriceSpecificationType["CategoryCodeChargeSpecification"] = "CategoryCodeChargeSpecification";
17
17
  /**
@@ -19,7 +19,7 @@ var PriceSpecificationType;
19
19
  */
20
20
  PriceSpecificationType["CompoundPriceSpecification"] = "CompoundPriceSpecification";
21
21
  /**
22
- * ムビチケ券種区分チャージ仕様
22
+ * 決済カード加算料金
23
23
  */
24
24
  PriceSpecificationType["MovieTicketTypeChargeSpecification"] = "MovieTicketTypeChargeSpecification";
25
25
  /**
package/lib/product.d.ts CHANGED
@@ -2,7 +2,7 @@ import { ICategoryCode } from './categoryCode';
2
2
  import { IMultilingualString } from './multilingualString';
3
3
  import { IName as IOfferName, IOffer as IBaseOffer } from './offer';
4
4
  import { OfferType } from './offerType';
5
- import { IPermit } from './permit';
5
+ import { IAmount as IPermitAmount, IPermit } from './permit';
6
6
  import { IPriceSpecification as ICategoryCodeChargeSpecification } from './priceSpecification/categoryCodeChargeSpecification';
7
7
  import { IPriceSpecification as ICompoundPriceSpecification } from './priceSpecification/compoundPriceSpecification';
8
8
  import { IPriceSpecification as IMovieTicketTypeChargeSpecification } from './priceSpecification/movieTicketTypeChargeSpecification';
@@ -43,10 +43,11 @@ export interface IHasOfferCatalog {
43
43
  typeOf: 'OfferCatalog';
44
44
  id: string;
45
45
  }
46
- export type IMembershipPointsEarned = Pick<IQuantitativeValue<string>, 'name' | 'typeOf' | 'unitText' | 'value'>;
47
- export type IServiceOutput = Pick<IPermit, 'typeOf' | 'amount'> & {
48
- membershipPointsEarned?: IMembershipPointsEarned;
49
- automaticRenewal?: boolean;
46
+ export type IServiceOutput = Pick<IPermit, 'typeOf'> & {
47
+ /**
48
+ * ペイメントカードの場合、通貨区分
49
+ */
50
+ amount?: Pick<IPermitAmount, 'currency' | 'typeOf'>;
50
51
  };
51
52
  /**
52
53
  * 外部サービス認証情報
@@ -102,6 +103,25 @@ export interface IProduct extends Pick<IThing, 'name' | 'description'> {
102
103
  serviceType?: IServiceType;
103
104
  additionalProperty?: IPropertyValue<string>[];
104
105
  }
106
+ export type ICreateParams = Pick<IProduct, 'typeOf' | 'productID' | 'name' | 'description' | 'availableChannel' | 'serviceOutput'> & {
107
+ hasOfferCatalog?: {
108
+ /**
109
+ * IDを指定する場合
110
+ */
111
+ id?: string;
112
+ /**
113
+ * カタログコードを指定する場合
114
+ */
115
+ identifier: string;
116
+ };
117
+ /**
118
+ * サービスタイプ
119
+ * 興行->興行区分
120
+ * メンバーシップ->メンバーシップ区分
121
+ * ペイメントカード->決済方法区分
122
+ */
123
+ serviceType?: Pick<IServiceType, 'codeValue'>;
124
+ };
105
125
  export interface ISortOrder {
106
126
  productID?: SortType;
107
127
  }
@@ -35,11 +35,11 @@ export interface IProviderCredentials {
35
35
  tokenizationCode?: string;
36
36
  paymentUrl?: IPaymentUrlSettings;
37
37
  /**
38
- * ムビチケ興行会社コード
38
+ * 決済カード興行会社コード
39
39
  */
40
40
  kgygishCd?: string;
41
41
  /**
42
- * ムビチケサイトコード
42
+ * 決済カードサイトコード
43
43
  */
44
44
  stCd?: string;
45
45
  }
package/lib/thing.d.ts CHANGED
@@ -18,6 +18,7 @@ export interface IThing {
18
18
  color?: string;
19
19
  /**
20
20
  * A description of the item.
21
+ * 説明
21
22
  */
22
23
  description?: string | IMultilingualString;
23
24
  /**
@@ -30,6 +31,7 @@ export interface IThing {
30
31
  image?: string;
31
32
  /**
32
33
  * The name of the item.
34
+ * 名称
33
35
  */
34
36
  name?: string | IMultilingualString;
35
37
  sameAs?: string;
@@ -93,7 +93,7 @@ export interface IReturnOrderActionParams {
93
93
  */
94
94
  refundCreditCard?: IRefundParams[];
95
95
  /**
96
- * ムビチケ着券取消を実行するかどうか
96
+ * 決済カード着券取消を実行するかどうか
97
97
  */
98
98
  /**
99
99
  * Eメール送信アクション
@@ -1,8 +1,9 @@
1
1
  import { IPointAward } from './action/transfer/moneyTransfer';
2
2
  import { ItemAvailability } from './itemAvailability';
3
- import { IAddOn, IName, IOffer } from './offer';
3
+ import { IAddOn, ICategory, IEligibleCategoryCode, IEligibleMonetaryAmount, IName, IOffer } from './offer';
4
4
  import { OfferType } from './offerType';
5
5
  import { IAmount as IPermitAmount, IDepositAmount, IPaymentAmount } from './permit';
6
+ import { IAccounting } from './priceSpecification';
6
7
  import { IPriceSpecification as IUnitPriceSpecification } from './priceSpecification/unitPriceSpecification';
7
8
  import { IProduct, ProductType } from './product';
8
9
  import { IQuantitativeValue } from './quantitativeValue';
@@ -47,6 +48,9 @@ export interface IAddOn4unitPriceOffer extends Pick<IAddOn, 'typeOf' | 'priceCur
47
48
  itemOffered: IAddOnItemOffered;
48
49
  }
49
50
  export interface ISettings {
51
+ /**
52
+ * 区分加算料金を適用しない
53
+ */
50
54
  ignoreCategoryCodeChargeSpec?: boolean;
51
55
  }
52
56
  export interface IAdvanceBookingRequirement extends Pick<IQuantitativeValue<UnitCode.Sec>, 'typeOf' | 'minValue' | 'unitCode' | 'description'> {
@@ -66,17 +70,74 @@ export interface IUnitPriceOffer extends Pick<IOffer, 'acceptedPaymentMethod' |
66
70
  * コード
67
71
  */
68
72
  identifier: string;
73
+ /**
74
+ * 名称
75
+ */
69
76
  name: IName;
70
77
  /**
71
78
  * 単価仕様
72
79
  */
73
80
  priceSpecification: IUnitPriceOfferPriceSpecification;
81
+ /**
82
+ * プロダクト
83
+ */
74
84
  itemOffered?: IItemOffered;
85
+ /**
86
+ * アドオン
87
+ */
75
88
  addOn?: IAddOn4unitPriceOffer[];
76
89
  typeOf: OfferType.Offer;
90
+ /**
91
+ * 返品ポリシー
92
+ */
77
93
  hasMerchantReturnPolicy?: IHasMerchantReturnPolicy;
94
+ /**
95
+ * オプション
96
+ */
78
97
  settings?: ISettings;
79
98
  }
99
+ export type ICreateParams = Pick<IUnitPriceOffer, 'acceptedPaymentMethod' | 'eligibleSubReservation' | 'additionalProperty' | 'alternateName' | 'availability' | 'availableAtOrFrom' | 'color' | 'description' | 'identifier' | 'itemOffered' | 'name' | 'settings' | 'validFrom' | 'validRateLimit' | 'validThrough'> & {
100
+ /**
101
+ * アドオン
102
+ */
103
+ addOn?: {
104
+ itemOffered: {
105
+ /**
106
+ * アドオンID
107
+ */
108
+ id: string;
109
+ };
110
+ }[];
111
+ /**
112
+ * 事前予約要件
113
+ */
114
+ advanceBookingRequirement?: Pick<IAdvanceBookingRequirement, 'description' | 'minValue'>;
115
+ /**
116
+ * カテゴリー
117
+ */
118
+ category?: Pick<ICategory, 'codeValue'>;
119
+ eligibleMembershipType?: Pick<IEligibleCategoryCode, 'codeValue'>[];
120
+ eligibleMonetaryAmount?: Pick<IEligibleMonetaryAmount, 'currency' | 'value'>[];
121
+ eligibleSeatingType?: Pick<IEligibleCategoryCode, 'codeValue'>[];
122
+ /**
123
+ * 返品ポリシー
124
+ */
125
+ hasMerchantReturnPolicy?: {
126
+ /**
127
+ * 返品ポリシーコード
128
+ */
129
+ identifier: string;
130
+ }[];
131
+ /**
132
+ * 価格仕様
133
+ */
134
+ priceSpecification: Pick<IUnitPriceOfferPriceSpecification, 'appliesToMovieTicket' | 'eligibleQuantity' | 'eligibleTransactionVolume' | 'price' | 'referenceQuantity'> & {
135
+ /**
136
+ * 勘定内容
137
+ */
138
+ accounting?: Pick<IAccounting, 'accountsReceivable' | 'operatingRevenue'>;
139
+ };
140
+ };
80
141
  /**
81
142
  * ソート条件
82
143
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@chevre/factory",
3
- "version": "4.347.0-alpha.1",
3
+ "version": "4.347.0-alpha.10",
4
4
  "description": "Chevre Factory Library for Javascript",
5
5
  "main": "./lib/index.js",
6
6
  "types": "./lib/index.d.ts",