@chevre/factory 4.393.0-alpha.4 → 4.393.0-alpha.40

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.
Files changed (86) hide show
  1. package/lib/action/accept/pay.d.ts +12 -3
  2. package/lib/action/authorize/paymentMethod/any.d.ts +39 -4
  3. package/lib/action/cancel/coaReserve.d.ts +30 -0
  4. package/lib/action/cancel/reservation.d.ts +13 -2
  5. package/lib/action/consume/use/reservation.d.ts +11 -5
  6. package/lib/action/consume/use.d.ts +1 -1
  7. package/lib/action/interact/inform.d.ts +37 -6
  8. package/lib/action/reserve.d.ts +11 -2
  9. package/lib/action/trade/pay.d.ts +22 -7
  10. package/lib/action/trade/refund.d.ts +27 -18
  11. package/lib/action/transfer/send/message/email.d.ts +2 -0
  12. package/lib/action.d.ts +18 -2
  13. package/lib/assetTransaction/cancelReservation.d.ts +8 -5
  14. package/lib/assetTransaction/pay.d.ts +16 -6
  15. package/lib/assetTransaction/refund.d.ts +23 -11
  16. package/lib/assetTransaction/reserve.d.ts +8 -1
  17. package/lib/authorization.d.ts +3 -0
  18. package/lib/certificationStatusEnumeration.d.ts +4 -0
  19. package/lib/certificationStatusEnumeration.js +8 -0
  20. package/lib/creativeWork/{certification.d.ts → certification/webApplication.d.ts} +5 -5
  21. package/lib/creativeWork/certification/webApplication.js +2 -0
  22. package/lib/creativeWork/certification/webSite.d.ts +47 -0
  23. package/lib/creativeWork/certification/webSite.js +2 -0
  24. package/lib/creativeWorkType.d.ts +2 -1
  25. package/lib/creativeWorkType.js +1 -0
  26. package/lib/entryPoint.d.ts +18 -0
  27. package/lib/entryPoint.js +2 -0
  28. package/lib/iam.d.ts +2 -2
  29. package/lib/iam.js +2 -2
  30. package/lib/identityProvider.d.ts +29 -0
  31. package/lib/identityProvider.js +2 -0
  32. package/lib/index.d.ts +41 -2
  33. package/lib/index.js +52 -4
  34. package/lib/notification/accountTitle.d.ts +4 -0
  35. package/lib/notification/accountTitle.js +2 -0
  36. package/lib/notification/categoryCode.d.ts +2 -0
  37. package/lib/notification/categoryCode.js +2 -0
  38. package/lib/notification/creativeWork.d.ts +4 -0
  39. package/lib/notification/creativeWork.js +2 -0
  40. package/lib/notification/event.d.ts +13 -0
  41. package/lib/notification/offer.d.ts +2 -0
  42. package/lib/notification/offer.js +2 -0
  43. package/lib/notification/offerCatalog.d.ts +4 -0
  44. package/lib/notification/offerCatalog.js +2 -0
  45. package/lib/notification/payAction.d.ts +8 -0
  46. package/lib/notification/payAction.js +2 -0
  47. package/lib/notification/person.d.ts +7 -0
  48. package/lib/notification/person.js +2 -0
  49. package/lib/notification/place.d.ts +9 -0
  50. package/lib/notification/place.js +2 -0
  51. package/lib/notification/product.d.ts +2 -0
  52. package/lib/notification/product.js +2 -0
  53. package/lib/notification/refundAction.d.ts +8 -0
  54. package/lib/notification/refundAction.js +2 -0
  55. package/lib/notification/transaction.d.ts +2 -0
  56. package/lib/notification/transaction.js +10 -0
  57. package/lib/potentialAction.d.ts +45 -0
  58. package/lib/potentialAction.js +2 -0
  59. package/lib/product.d.ts +3 -6
  60. package/lib/recipe/cancelPendingCOAReserve.d.ts +23 -0
  61. package/lib/recipe/cancelPendingCOAReserve.js +2 -0
  62. package/lib/recipe/refundCreditCard.d.ts +1 -1
  63. package/lib/recipe/sendEmailMessage.d.ts +22 -0
  64. package/lib/recipe/sendEmailMessage.js +2 -0
  65. package/lib/recipe.d.ts +6 -2
  66. package/lib/recipe.js +4 -0
  67. package/lib/service/paymentService.d.ts +17 -2
  68. package/lib/serviceChannel.d.ts +0 -3
  69. package/lib/task/cancelPendingReservation.d.ts +12 -2
  70. package/lib/task/handleNotification.d.ts +5 -0
  71. package/lib/task/invalidatePaymentUrl.d.ts +15 -0
  72. package/lib/task/invalidatePaymentUrl.js +2 -0
  73. package/lib/task/onAuthorizationCreated.d.ts +6 -2
  74. package/lib/task/pay.d.ts +8 -5
  75. package/lib/task/publishPaymentUrl.d.ts +7 -2
  76. package/lib/task/refund.d.ts +5 -3
  77. package/lib/task/triggerWebhook.d.ts +74 -4
  78. package/lib/task/useReservation.d.ts +1 -1
  79. package/lib/task/voidPayTransaction.d.ts +0 -2
  80. package/lib/task/voidReserveTransaction.d.ts +0 -2
  81. package/lib/taskName.d.ts +1 -0
  82. package/lib/taskName.js +1 -0
  83. package/lib/taskStatus.d.ts +11 -6
  84. package/lib/taskStatus.js +10 -5
  85. package/package.json +1 -1
  86. /package/lib/{creativeWork/certification.js → action/cancel/coaReserve.js} +0 -0
@@ -1,13 +1,17 @@
1
1
  import * as ActionFactory from '../../action';
2
2
  import { ActionType } from '../../actionType';
3
- import { IAgent, IObjectWithoutDetail } from '../../assetTransaction/pay';
3
+ import { IAgent, IObjectWithoutDetail, IPaymentMethodWithoutDetail } from '../../assetTransaction/pay';
4
4
  import { AssetTransactionType } from '../../assetTransactionType';
5
5
  import { IExecTran3dsArgs, IExecTran3dsResult, IRecipe } from '../../recipe/publishPaymentUrl';
6
6
  import { TransactionType } from '../../transactionType';
7
7
  import * as AcceptActionFactory from '../accept';
8
8
  export { IExecTran3dsArgs, IExecTran3dsResult, IAgent, IRecipe };
9
+ export type IPaymentMethod = Pick<IPaymentMethodWithoutDetail, 'amount' | 'creditCard' | 'identifier' | 'method'>;
10
+ export type IPayObject = Pick<IObjectWithoutDetail, 'id' | 'typeOf'> & {
11
+ paymentMethod: IPaymentMethod;
12
+ };
9
13
  export interface IObject {
10
- object: IObjectWithoutDetail;
14
+ object: IPayObject;
11
15
  transactionNumber: string;
12
16
  typeOf: AssetTransactionType.Pay;
13
17
  }
@@ -22,11 +26,16 @@ export interface IPurpose {
22
26
  /**
23
27
  * 決済採用アクション属性
24
28
  */
25
- export interface IAttributes extends AcceptActionFactory.IAttributes<IObject, IResult> {
29
+ export interface IAttributes extends Pick<AcceptActionFactory.IAttributes<IObject, IResult>, 'agent' | 'error' | 'identifier' | 'location' | 'object' | 'project' | 'purpose' | 'result' | 'sameAs' | 'typeOf'> {
26
30
  typeOf: ActionType.AcceptAction;
27
31
  object: IObject;
28
32
  agent: IAgent;
29
33
  purpose: IPurpose;
34
+ /**
35
+ * add identifier for an unique index(2025-02-25~)
36
+ * authorize payment action identifier
37
+ */
38
+ identifier?: string;
30
39
  }
31
40
  /**
32
41
  * 決済採用アクション
@@ -82,13 +82,43 @@ export interface IObjectIncludingPaymentMethodDetails {
82
82
  */
83
83
  ticketToken?: string;
84
84
  }
85
- export type IObjectWithoutDetail = Pick<IObjectIncludingPaymentMethodDetails, 'additionalProperty' | 'amount' | 'issuedThrough' | 'paymentMethod' | 'description' | 'name' | 'creditCard' | 'method' | 'movieTickets' | 'fromLocation' | 'ticketToken'> & {
85
+ export type IAuthorizeAnyPaymentObject = Pick<IObjectIncludingPaymentMethodDetails, 'amount' | 'issuedThrough' | 'paymentMethod' | 'name' | 'additionalProperty' | 'ticketToken'> & {
86
+ creditCard?: never;
87
+ method?: never;
88
+ movieTickets?: never;
89
+ paymentMethodId?: never;
90
+ fromLocation?: never;
91
+ description?: string;
92
+ };
93
+ export type IAuthorizeCreditCardObject = Pick<IObjectIncludingPaymentMethodDetails, 'amount' | 'issuedThrough' | 'paymentMethod' | 'creditCard' | 'method' | 'name' | 'additionalProperty' | 'ticketToken'> & {
86
94
  /**
87
- * 外部決済URL発行の場合に指定
88
- * CreditCardのみ対応
95
+ * 決済URL発行の場合、発行済のpaymentMethodIdを指定
89
96
  */
90
97
  paymentMethodId?: string;
98
+ movieTickets?: never;
99
+ fromLocation?: never;
100
+ description?: string;
101
+ };
102
+ export type IAuthorizeMovieTicketObject = Pick<IObjectIncludingPaymentMethodDetails, 'issuedThrough' | 'paymentMethod' | 'movieTickets' | 'name' | 'additionalProperty' | 'ticketToken'> & {
103
+ /**
104
+ * fix 0 as JPY
105
+ */
106
+ amount: 0;
107
+ creditCard?: never;
108
+ method?: never;
109
+ paymentMethodId?: never;
110
+ fromLocation?: never;
111
+ description?: string;
112
+ };
113
+ export type IAuthorizePaymentCardObject = Pick<IObjectIncludingPaymentMethodDetails, 'amount' | 'issuedThrough' | 'paymentMethod' | 'fromLocation' | 'name' | 'additionalProperty'> & {
114
+ description?: string;
115
+ creditCard?: never;
116
+ method?: never;
117
+ movieTickets?: never;
118
+ ticketToken?: never;
119
+ paymentMethodId?: never;
91
120
  };
121
+ export type IObjectWithoutDetail = IAuthorizeAnyPaymentObject | IAuthorizeCreditCardObject | IAuthorizeMovieTicketObject | IAuthorizePaymentCardObject;
92
122
  export type IObject = Pick<IObjectIncludingPaymentMethodDetails, 'typeOf' | 'paymentMethodId' | 'accountId'>;
93
123
  export interface IResultPaymentMethod {
94
124
  /**
@@ -169,8 +199,13 @@ export interface IAttributes extends AuthorizeActionFactory.IAttributes<IObject,
169
199
  instrument: IInstrument;
170
200
  recipient: IRecipient;
171
201
  purpose: IPurpose;
202
+ /**
203
+ * add identifier for an unique index(2025-02-25~)
204
+ * authorize payment action identifier
205
+ */
206
+ identifier: string;
172
207
  }
173
208
  /**
174
- * 決済承認アクション
209
+ * authorize payment action
175
210
  */
176
211
  export type IAction = ActionFactory.IAction<IAttributes>;
@@ -0,0 +1,30 @@
1
+ import * as ActionFactory from '../../action';
2
+ import { ActionType } from '../../actionType';
3
+ import { AssetTransactionType } from '../../assetTransactionType';
4
+ import { IOrder } from '../../order';
5
+ import { IDelTmpReserveArgs, IRecipe, IResultAsError } from '../../recipe/cancelPendingCOAReserve';
6
+ import { IAvailableReservationStatusType } from '../../reservation';
7
+ import { ITransaction as IPlaceOrder } from '../../transaction/placeOrder';
8
+ import { IAction as IReturnReserveTransactionAction } from '../transfer/return/reserveTransaction';
9
+ export { IRecipe as ICancelPendingCOAReserveRecipe };
10
+ export type IDelTmpReserveResultAsError = IResultAsError;
11
+ export type IAgent = ActionFactory.IParticipantAsProject;
12
+ export type IObject = IDelTmpReserveArgs & {
13
+ reservationStatus: IAvailableReservationStatusType;
14
+ transactionNumber: string;
15
+ typeOf: AssetTransactionType.COAReserveTransaction;
16
+ };
17
+ export interface IResult {
18
+ }
19
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
20
+ export type IReturnActionAsInstrument = Pick<IReturnReserveTransactionAction, 'id' | 'purpose' | 'typeOf'>;
21
+ export type IPlaceOrderAsInstrument = Pick<IPlaceOrder, 'id' | 'typeOf'>;
22
+ export type IInstrument = IOrderAsInstrument | IReturnActionAsInstrument | IPlaceOrderAsInstrument;
23
+ export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.CancelAction, IObject, IResult>, 'typeOf' | 'result' | 'project' | 'object' | 'agent' | 'instrument'> {
24
+ agent: IAgent;
25
+ instrument?: IInstrument[];
26
+ }
27
+ /**
28
+ * cancel coa reserve
29
+ */
30
+ export type IAction = ActionFactory.IAction<IAttributes>;
@@ -2,10 +2,13 @@ import * as ActionFactory from '../../action';
2
2
  import { ActionType } from '../../actionType';
3
3
  import { AssetTransactionType } from '../../assetTransactionType';
4
4
  import { EventType } from '../../eventType';
5
+ import { IOrder } from '../../order';
5
6
  import { ProductType } from '../../product';
6
7
  import { IAvailableReservationStatusType } from '../../reservation';
7
8
  import { ReservationType } from '../../reservationType';
9
+ import { ITransaction as IPlaceOrder } from '../../transaction/placeOrder';
8
10
  import { TripType } from '../../tripType';
11
+ import { IAction as IReturnReserveTransactionAction } from '../transfer/return/reserveTransaction';
9
12
  export type IAgent = ActionFactory.IParticipantAsProject;
10
13
  export interface IReservationPackageAsObject {
11
14
  reservationFor: {
@@ -64,11 +67,19 @@ export interface IPurpose {
64
67
  */
65
68
  id: string;
66
69
  }
67
- export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.CancelAction, IObject, IResult>, 'typeOf' | 'result' | 'purpose' | 'project' | 'object' | 'agent'> {
70
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
71
+ export type IReturnActionAsInstrument = Pick<IReturnReserveTransactionAction, 'id' | 'purpose' | 'typeOf'>;
72
+ export type IPlaceOrderAsInstrument = Pick<IPlaceOrder, 'id' | 'typeOf'>;
73
+ export type IInstrument = IOrderAsInstrument | IReturnActionAsInstrument | IPlaceOrderAsInstrument;
74
+ export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.CancelAction, IObject, IResult>, 'typeOf' | 'result' | 'purpose' | 'project' | 'object' | 'agent' | 'instrument'> {
68
75
  agent: IAgent;
69
76
  purpose: IPurpose;
77
+ /**
78
+ * add(2025-02-17~)
79
+ */
80
+ instrument?: IInstrument[];
70
81
  }
71
82
  /**
72
- * 予約取消アクション
83
+ * cancel reservation action
73
84
  */
74
85
  export type IAction = ActionFactory.IAction<IAttributes>;
@@ -1,4 +1,5 @@
1
1
  import { IParticipantAsPerson, IParticipantAsWebApplication } from '../../../action';
2
+ import { IOrder } from '../../../order';
2
3
  import { PlaceType } from '../../../placeType';
3
4
  import { ITicket, ITicketType } from '../../../reservation';
4
5
  import { IIssuedThrough, IReservation, IReservationFor } from '../../../reservation/event';
@@ -18,11 +19,12 @@ export interface IResult {
18
19
  export interface ILocation {
19
20
  typeOf: PlaceType.Place;
20
21
  /**
21
- * 入場ゲートコード
22
+ * entrance gate identifier
22
23
  */
23
24
  identifier: string;
24
25
  }
25
- export interface IInstrument {
26
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
27
+ export interface ITicketAsInstrument {
26
28
  /**
27
29
  * JWT
28
30
  */
@@ -33,12 +35,16 @@ export interface IInstrument {
33
35
  ticketToken?: string;
34
36
  typeOf: ObjectType.Ticket;
35
37
  }
36
- export interface IAttributes extends UseActionFactory.IAttributes<IObject, IResult> {
38
+ export type IInstrument = IOrderAsInstrument | ITicketAsInstrument;
39
+ export interface IAttributes extends Pick<UseActionFactory.IAttributes<IObject, IResult>, 'agent' | 'error' | 'instrument' | 'location' | 'object' | 'project' | 'result' | 'typeOf' | 'error'> {
37
40
  agent: IAgent;
38
- instrument: IInstrument;
41
+ /**
42
+ * extend to array(2025-02-17~)
43
+ */
44
+ instrument: IInstrument | IInstrument[];
39
45
  location?: ILocation;
40
46
  }
41
47
  /**
42
- * 予約使用アクション
48
+ * use reservation action
43
49
  */
44
50
  export type IAction = UseActionFactory.IAction<IAttributes>;
@@ -5,6 +5,6 @@ export type IResult = any;
5
5
  export interface IAttributes<TObject, TResult> extends Pick<ActionFactory.IAttributes<ActionType.UseAction, TObject, TResult>, 'typeOf' | 'result' | 'project' | 'object' | 'location' | 'error' | 'instrument' | 'agent'> {
6
6
  }
7
7
  /**
8
- * 使用アクション
8
+ * use action
9
9
  */
10
10
  export type IAction<TAttributes extends IAttributes<IObject, IResult>> = ActionFactory.IAction<TAttributes>;
@@ -1,10 +1,40 @@
1
1
  import * as ActionFactory from '../../action';
2
2
  import { ActionType } from '../../actionType';
3
3
  import { AssetTransactionType } from '../../assetTransactionType';
4
+ import { EventType } from '../../eventType';
4
5
  import { IOrder } from '../../order';
6
+ import { ITransaction as IPlaceOrder } from '../../transaction/placeOrder';
7
+ import { IAccountTitleAsNotification } from '../../notification/accountTitle';
8
+ import { ICategoryCodeAsNotification } from '../../notification/categoryCode';
9
+ import { IMovieAsNotification, INoteDigitalDocumentAsNotification } from '../../notification/creativeWork';
10
+ import { IEvent4inform, IEventAsNotification } from '../../notification/event';
11
+ import { IOfferAsNotification } from '../../notification/offer';
12
+ import { IOfferCatalogAsNotification } from '../../notification/offerCatalog';
13
+ import { IOrder4inform } from '../../notification/order';
14
+ import { IPayAction4inform } from '../../notification/payAction';
15
+ import { IPersonAsNotification } from '../../notification/person';
16
+ import { IHasPOSAsNotification, IMovieTheaterAsNotification } from '../../notification/place';
17
+ import { IProductAsNotification } from '../../notification/product';
18
+ import { IRefundAction4inform } from '../../notification/refundAction';
19
+ import { IReservation4inform } from '../../notification/reservation';
20
+ import { IPlaceOrderAsNotification } from '../../notification/transaction';
5
21
  export type IAgent = ActionFactory.IParticipantAsProject;
6
- export type IRecipient = ActionFactory.IParticipant;
7
- export type IObject = any;
22
+ export type IRecipientAsWebApplicationDeprecated = Pick<ActionFactory.IRecipientAsAnonymousWebApplication, 'id' | 'name' | 'typeOf'> & {
23
+ url?: string;
24
+ };
25
+ export type IRecipientAsSellerDeprecated = Pick<ActionFactory.IParticipantAsSeller, 'id' | 'name' | 'typeOf'> & {
26
+ url?: string;
27
+ };
28
+ export type IRecipientDeprecated = IRecipientAsWebApplicationDeprecated | IRecipientAsSellerDeprecated;
29
+ /**
30
+ * redefine informAction.recipient(2025-02-15~)
31
+ */
32
+ export type IRecipient = Pick<ActionFactory.IParticipantAsWebApplication, 'name' | 'typeOf'> & {
33
+ id?: never;
34
+ url?: never;
35
+ };
36
+ export type IAnyResourceAsObject = IPlaceOrderAsNotification | IOfferCatalogAsNotification | IHasPOSAsNotification | IMovieTheaterAsNotification | IOfferAsNotification | IAccountTitleAsNotification | IProductAsNotification | ICategoryCodeAsNotification | IMovieAsNotification | INoteDigitalDocumentAsNotification | IPersonAsNotification | IEvent4inform | IEventAsNotification<EventType>;
37
+ export type IObject = IAnyResourceAsObject | IOrder4inform | IReservation4inform | IPayAction4inform | IRefundAction4inform;
8
38
  export interface IPayTransactionAsPurpose {
9
39
  id: string;
10
40
  typeOf: AssetTransactionType.Pay;
@@ -15,18 +45,19 @@ export interface IRefundTransactionAsPurpose {
15
45
  }
16
46
  export type IPurpose = IPayTransactionAsPurpose | IRefundTransactionAsPurpose;
17
47
  export type IOrderAsAbout = Pick<IOrder, 'orderNumber' | 'typeOf'>;
18
- export type IAbout = IOrderAsAbout;
48
+ export type IPlaceOrderAsAbout = Pick<IPlaceOrder, 'id' | 'typeOf'>;
49
+ export type IAbout = IOrderAsAbout | IPlaceOrderAsAbout;
19
50
  export interface IResult {
20
51
  statusCode?: number;
21
52
  useFetchAPI?: boolean;
22
53
  }
23
- export interface IAttributes<TObject> extends Pick<ActionFactory.IAttributes<ActionType.InformAction, TObject, IResult>, 'agent' | 'object' | 'project' | 'purpose' | 'recipient' | 'result' | 'typeOf'> {
54
+ export interface IAttributes<TObject extends IObject> extends Pick<ActionFactory.IAttributes<ActionType.InformAction, TObject, IResult>, 'agent' | 'object' | 'project' | 'purpose' | 'recipient' | 'result' | 'typeOf' | 'target'> {
24
55
  agent: IAgent;
25
- recipient: IRecipient;
56
+ recipient: IRecipient | IRecipientDeprecated;
26
57
  purpose?: IPurpose;
27
58
  about?: IAbout;
28
59
  }
29
60
  /**
30
- * 通知アクション
61
+ * inform action
31
62
  */
32
63
  export type IAction<TAttributes extends IAttributes<IObject>> = ActionFactory.IAction<TAttributes>;
@@ -1,10 +1,12 @@
1
1
  import * as ActionFactory from '../action';
2
2
  import { ActionType } from '../actionType';
3
3
  import { AssetTransactionType } from '../assetTransactionType';
4
+ import { IOrder } from '../order';
4
5
  import { IAvailableReservationStatusType } from '../reservation';
5
6
  import { IReservationFor as IBusReservationFor } from '../reservation/busReservation';
6
7
  import { IReservationFor as IEventReservationFor } from '../reservation/event';
7
8
  import { ReservationType } from '../reservationType';
9
+ import { ITransaction as IPlaceOrder } from '../transaction/placeOrder';
8
10
  import { IAttributes as IMoneyTransferActionAttributes } from './transfer/moneyTransfer';
9
11
  export type IAgent = ActionFactory.IParticipantAsProject;
10
12
  export type IReservationFor = (Pick<IBusReservationFor, 'id' | 'typeOf'> | Pick<IEventReservationFor, 'id' | 'typeOf'>) & {
@@ -33,12 +35,19 @@ export type IPurpose = IAssetTransactionAsReservePurpose;
33
35
  export interface IPotentialActions {
34
36
  moneyTransfer?: IMoneyTransferActionAttributes[];
35
37
  }
36
- export interface IAttributes extends ActionFactory.IAttributes<ActionType.ReserveAction, IObject, IResult> {
38
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
39
+ export type IPlaceOrderAsInstrument = Pick<IPlaceOrder, 'id' | 'typeOf'>;
40
+ export type IInstrument = IOrderAsInstrument | IPlaceOrderAsInstrument;
41
+ export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.ReserveAction, IObject, IResult>, 'agent' | 'object' | 'potentialActions' | 'project' | 'purpose' | 'typeOf' | 'error' | 'instrument'> {
37
42
  agent: IAgent;
38
43
  potentialActions?: IPotentialActions;
39
44
  purpose: IPurpose;
45
+ /**
46
+ * add(2025-02-17~)
47
+ */
48
+ instrument?: IInstrument[];
40
49
  }
41
50
  /**
42
- * 予約アクション
51
+ * reserve action
43
52
  */
44
53
  export type IAction = ActionFactory.IAction<IAttributes>;
@@ -5,19 +5,24 @@ import { ActionType } from '../../actionType';
5
5
  import { AssetTransactionType } from '../../assetTransactionType';
6
6
  import { CreativeWorkType } from '../../creativeWorkType';
7
7
  import { IPaymentServiceOutput } from '../../invoice';
8
- import { ITotalPaymentDue, OrderType } from '../../order';
8
+ import { IOrder, ITotalPaymentDue, OrderType } from '../../order';
9
9
  import { IMovieTicketPaymentCard } from '../../paymentMethod/paymentCard/movieTicket';
10
10
  import { IPropertyValue } from '../../propertyValue';
11
11
  import { IAlterTranResult, IRecipe as IPayCreditCardRecipe } from '../../recipe/payCreditCard';
12
12
  import { IRecipe as IPayMovieTicketRecipe, ISeatInfoSyncIn, ISeatInfoSyncResult } from '../../recipe/payMovieTicket';
13
13
  import { PaymentServiceType } from '../../service/paymentService';
14
- import { IAttributes as IInformActionAttributes } from '../interact/inform';
14
+ import { IAction as IAuthorizeInvoiceAction } from '../authorize/invoice';
15
+ import { IPayTransactionAsPurpose, IRefundTransactionAsPurpose } from '../interact/inform';
16
+ import { IAction as IRefundAction } from './refund';
15
17
  export { IAlterTranResult, ISeatInfoSyncIn, ISeatInfoSyncResult, IPayCreditCardRecipe, IPayMovieTicketRecipe };
16
18
  export import IAgent = ActionFactory.IParticipantAsProject;
17
19
  export import IRecipient = ActionFactory.IParticipantAsSeller;
18
20
  export interface IOrderAsPayPurpose {
19
21
  typeOf: OrderType.Order;
20
22
  confirmationNumber: string;
23
+ /**
24
+ * required(2025-02-14~)
25
+ */
21
26
  orderNumber?: string;
22
27
  }
23
28
  export interface IPurposeAsAssetTransaction {
@@ -26,7 +31,7 @@ export interface IPurposeAsAssetTransaction {
26
31
  transactionNumber?: string;
27
32
  }
28
33
  export type IPurposeAsReturnAction = Pick<IReturnOrderActionAttributes, 'object' | 'typeOf'>;
29
- export type IPurpose = IOrderAsPayPurpose | IPurposeAsAssetTransaction | IPurposeAsReturnAction;
34
+ export type IPurpose = IOrderAsPayPurpose | IPurposeAsReturnAction;
30
35
  export type AvailablePaymentMethodType = string;
31
36
  export interface IPendingTransaction {
32
37
  typeOf: AccountFactory.transactionType;
@@ -92,16 +97,27 @@ export interface IPaymentService {
92
97
  serviceOutput?: IPaymentServiceOutput;
93
98
  }
94
99
  export type IObject = [IPaymentService];
95
- export type IInformPayment = Pick<IInformActionAttributes<{}>, 'recipient' | 'purpose'>;
100
+ export interface IInformPayment {
101
+ purpose: IPayTransactionAsPurpose | IRefundTransactionAsPurpose;
102
+ recipient?: never;
103
+ /**
104
+ * potentialAction id
105
+ */
106
+ id: string;
107
+ }
96
108
  export interface IPotentialActions {
97
109
  add2report: boolean;
98
110
  informPayment?: IInformPayment[];
99
111
  }
100
- export interface IInstrument {
112
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
113
+ export type IAuthorizeActionAsInstrument = Pick<IAuthorizeInvoiceAction, 'id' | 'typeOf'>;
114
+ export interface IPayTransactionAsInstrument {
101
115
  id: string;
102
116
  transactionNumber: string;
103
117
  typeOf: AssetTransactionType.Pay;
104
118
  }
119
+ export type IRefundActionAsInstrument = Pick<IRefundAction, 'id' | 'typeOf'>;
120
+ export type IInstrument = IPayTransactionAsInstrument | IOrderAsInstrument | IAuthorizeActionAsInstrument | IRefundActionAsInstrument;
105
121
  export interface IResult {
106
122
  }
107
123
  export interface ILocation {
@@ -114,11 +130,10 @@ export interface ILocation {
114
130
  export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.PayAction, IObject, IResult>, 'agent' | 'error' | 'instrument' | 'location' | 'object' | 'potentialActions' | 'purpose' | 'recipient' | 'result' | 'project' | 'sameAs' | 'typeOf'> {
115
131
  agent: IAgent;
116
132
  /**
117
- * redefine IInstrument(2024-06-15~)
118
133
  * 注文決済の場合、決済取引として存在(2024-06-15~)
119
134
  * 返品手数料決済の場合、存在しない
120
135
  */
121
- instrument?: IInstrument;
136
+ instrument?: IPayTransactionAsInstrument | IInstrument[];
122
137
  potentialActions?: IPotentialActions;
123
138
  purpose: IPurpose;
124
139
  recipient: IRecipient;
@@ -1,10 +1,12 @@
1
1
  import * as ActionFactory from '../../action';
2
2
  import { ActionType } from '../../actionType';
3
- import { IAlterTranResult, IRecipe as IRefundCreditCardRecipe } from '../../recipe/refundCreditCard';
4
- import { IRecipe as IRefundMovieTicketRecipe, ISeatInfoSyncCancelIn, ISeatInfoSyncCancelResult, ISeatInfoSyncIn, ISeatInfoSyncResult } from '../../recipe/refundMovieTicket';
3
+ import { IOrder } from '../../order';
4
+ import { IAlterTranResult, IRecipe as IRefundCreditCardRecipe, IResultAsError as IRefundCreditCardResultAsError } from '../../recipe/refundCreditCard';
5
+ import { IRecipe as IRefundMovieTicketRecipe, IResultAsError as IRefundMovieTicketResultAsError, ISeatInfoSyncCancelIn, ISeatInfoSyncCancelResult, ISeatInfoSyncIn, ISeatInfoSyncResult } from '../../recipe/refundMovieTicket';
5
6
  import { TransactionType } from '../../transactionType';
6
- import { IAttributes as IInformActionAttributes } from '../interact/inform';
7
- import { IOrderAsPayPurpose, IPaymentMethod, IPaymentService as IPaymentServiceOnPay, IPurposeAsAssetTransaction, IPurposeAsReturnAction } from './pay';
7
+ import { IRefundTransactionAsPurpose } from '../interact/inform';
8
+ import { IAction as IReturnInvoiceAction } from '../transfer/return/invoice';
9
+ import { IOrderAsPayPurpose, IPaymentMethod, IPaymentService as IPaymentServiceOnPay, IPurposeAsReturnAction } from './pay';
8
10
  export { IAlterTranResult, ISeatInfoSyncCancelIn, ISeatInfoSyncCancelResult, ISeatInfoSyncIn, ISeatInfoSyncResult, IRefundCreditCardRecipe, IRefundMovieTicketRecipe };
9
11
  export type IAgent = ActionFactory.IParticipantAsSeller;
10
12
  export type IRecipient = ActionFactory.IParticipant;
@@ -13,14 +15,9 @@ export type IPaymentService = Omit<IPaymentServiceOnPay, 'paymentMethod'> & {
13
15
  paymentMethod: Pick<IPaymentMethod, 'accountId' | 'name' | 'paymentMethodId' | 'typeOf' | 'additionalProperty'>;
14
16
  };
15
17
  export type IObject = [IPaymentService];
16
- export interface IAlterTranResultAsError {
17
- name: string;
18
- message: string;
19
- }
20
- export interface ISeatInfoSyncResultAsError {
21
- name: string;
22
- message: string;
23
- }
18
+ export type IAlterTranResultAsError = IRefundCreditCardResultAsError;
19
+ export type ISearchTradeResultAsError = IRefundCreditCardResultAsError;
20
+ export type ISeatInfoSyncResultAsError = IRefundMovieTicketResultAsError;
24
21
  export interface IResult {
25
22
  /**
26
23
  * ペイメントカード決済の場合
@@ -29,7 +26,14 @@ export interface IResult {
29
26
  transactionNumber: string;
30
27
  };
31
28
  }
32
- export type IInformPayment = Pick<IInformActionAttributes<{}>, 'recipient' | 'purpose'>;
29
+ export interface IInformPayment {
30
+ purpose: IRefundTransactionAsPurpose;
31
+ recipient?: never;
32
+ /**
33
+ * potentialAction id
34
+ */
35
+ id: string;
36
+ }
33
37
  export interface IPotentialActions {
34
38
  add2report: boolean;
35
39
  informPayment?: IInformPayment[];
@@ -38,17 +42,22 @@ export interface IPurposeAsPlaceOrder {
38
42
  typeOf: TransactionType.PlaceOrder;
39
43
  id: string;
40
44
  }
41
- export type IPurpose = IOrderAsPayPurpose | // 決済カードIF承認時の着券取消の場合
42
- IPurposeAsReturnAction | // 注文返品の場合
43
- IPurposeAsPlaceOrder | // 注文取引における発行済決済URL無効化の場合
44
- IPurposeAsAssetTransaction;
45
+ export { IOrderAsPayPurpose, IPurposeAsReturnAction };
46
+ export type IPurpose = IOrderAsPayPurpose | IPurposeAsReturnAction | IPurposeAsPlaceOrder;
47
+ export type IOrderAsInstrument = Pick<IOrder, 'orderNumber' | 'typeOf'>;
48
+ export type IReturnActionAsInstrument = Pick<IReturnInvoiceAction, 'id' | 'typeOf'>;
49
+ export type IInstrument = IOrderAsInstrument | IReturnActionAsInstrument;
45
50
  export interface IAttributes extends Pick<ActionFactory.IAttributes<ActionType.RefundAction, IObject, IResult>, 'agent' | 'error' | 'object' | 'potentialActions' | 'purpose' | 'recipient' | 'result' | 'project' | 'sameAs' | 'typeOf'> {
46
51
  agent: IAgent;
47
52
  recipient?: IRecipient;
48
53
  purpose: IPurpose;
49
54
  potentialActions?: IPotentialActions;
55
+ /**
56
+ * add(2025-02-17~)
57
+ */
58
+ instrument?: IInstrument[];
50
59
  }
51
60
  /**
52
- * 返金アクション
61
+ * refund action
53
62
  */
54
63
  export type IAction = ActionFactory.IAction<IAttributes>;
@@ -1,7 +1,9 @@
1
1
  import { IParticipantAsCustomer, IParticipantAsPerson, IParticipantAsProject, IParticipantAsWebApplication } from '../../../../action';
2
2
  import { ICreativeWork as IEmailMessage } from '../../../../creativeWork/message/email';
3
3
  import { ISimpleOrder } from '../../../../order';
4
+ import { IRecipe, ISendMultipleArgs, ISendMultipleResult } from '../../../../recipe/sendEmailMessage';
4
5
  import * as SendActionFactory from '../../send';
6
+ export { IRecipe, ISendMultipleArgs, ISendMultipleResult };
5
7
  export type IAgent = IParticipantAsProject;
6
8
  export type IRecipient = IParticipantAsWebApplication | IParticipantAsPerson | IParticipantAsCustomer;
7
9
  export type IObjectAsEmailMessage = Pick<IEmailMessage, 'about' | 'identifier' | 'name' | 'sender' | 'text' | 'toRecipient' | 'typeOf'>;
package/lib/action.d.ts CHANGED
@@ -3,14 +3,18 @@ import { ActionType } from './actionType';
3
3
  import { AssetTransactionType } from './assetTransactionType';
4
4
  import { IExtendId } from './autoGenerated';
5
5
  import { CreativeWorkType } from './creativeWorkType';
6
+ import { IEntryPoint } from './entryPoint';
6
7
  import { OrganizationType } from './organizationType';
7
8
  import { IPersonAttributes } from './person';
8
9
  import { IProject } from './project';
9
10
  import { SortType } from './sortType';
10
11
  export interface IParticipantOptionalAttributes {
11
12
  name?: string;
12
- url?: string;
13
13
  }
14
+ export type IRecipientAsAnonymousWebApplication = IParticipantOptionalAttributes & {
15
+ typeOf: CreativeWorkType.WebApplication;
16
+ id?: never;
17
+ };
14
18
  export type IParticipantAsWebApplication = IParticipantOptionalAttributes & {
15
19
  typeOf: CreativeWorkType.WebApplication;
16
20
  id: string;
@@ -47,6 +51,7 @@ export interface IPurpose {
47
51
  typeOf: string;
48
52
  id?: string;
49
53
  }
54
+ export type IRecipient = IParticipant | IRecipientAsAnonymousWebApplication;
50
55
  export interface ISameAs {
51
56
  /**
52
57
  * タスクID or 資産取引ID
@@ -70,7 +75,7 @@ export interface IAttributes<T extends ActionType, TObject, TResult> {
70
75
  object: TObject;
71
76
  potentialActions?: any;
72
77
  purpose?: IPurpose;
73
- recipient?: IParticipant;
78
+ recipient?: IRecipient;
74
79
  result?: TResult;
75
80
  sameAs?: ISameAs;
76
81
  /**
@@ -84,6 +89,11 @@ export interface IAttributes<T extends ActionType, TObject, TResult> {
84
89
  targetCollection?: any;
85
90
  cancelAction?: any;
86
91
  about?: any;
92
+ target?: IEntryPoint;
93
+ /**
94
+ * globally unique identifier(2025-02-25~)
95
+ */
96
+ identifier?: string;
87
97
  }
88
98
  /**
89
99
  * アクション動的属性
@@ -154,6 +164,12 @@ export interface ISearchConditions {
154
164
  identifier?: {
155
165
  $eq?: string;
156
166
  };
167
+ id?: {
168
+ $eq?: string;
169
+ };
170
+ orderNumber?: {
171
+ $eq?: string;
172
+ };
157
173
  };
158
174
  location?: {
159
175
  id?: {
@@ -1,4 +1,4 @@
1
- import { IAttributes as ICancelReservationActionAttributes } from '../action/cancel/reservation';
1
+ import { IAttributes as ICancelReservationActionAttributes, IOrderAsInstrument, IReturnActionAsInstrument } from '../action/cancel/reservation';
2
2
  import * as AssetTransactionFactory from '../assetTransaction';
3
3
  import { ITransaction as IReserveTransaction } from '../assetTransaction/reserve';
4
4
  import { AssetTransactionType } from '../assetTransactionType';
@@ -8,10 +8,13 @@ import { IReservation as IEventReservation, IReservationFor as IEventReservation
8
8
  import { IReservation as IReservationPackage } from '../reservation/reservationPackage';
9
9
  export import IAgent = AssetTransactionFactory.IAgent;
10
10
  export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.CancelReservation, IAgent, undefined, IObjectWithoutDetail>;
11
- /**
12
- * 取引開始パラメータ
13
- */
14
- export type IStartParams = AssetTransactionFactory.IStartParams<AssetTransactionType.CancelReservation, IAgent, undefined, IObject>;
11
+ export type IInstrument = IOrderAsInstrument | IReturnActionAsInstrument;
12
+ export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.CancelReservation, IAgent, undefined, IObject> {
13
+ /**
14
+ * add(2025-02-17~)
15
+ */
16
+ instrument?: IInstrument[];
17
+ }
15
18
  export interface IResult {
16
19
  }
17
20
  /**
@@ -1,14 +1,13 @@
1
- import { IAction as IPayAction, ILocation, IMovieTicket, IOrderAsPayPurpose, IPendingTransaction, IPurpose as IPayPurpose, IRecipient as IPayRecipient } from '../action/trade/pay';
1
+ import { IAction as IPayAction, IInstrument, ILocation, IMovieTicket, IOrderAsPayPurpose, IPendingTransaction, IRecipient as IPayRecipient } from '../action/trade/pay';
2
2
  import * as AssetTransactionFactory from '../assetTransaction';
3
3
  import { AssetTransactionType } from '../assetTransactionType';
4
4
  import { IExtendId } from '../autoGenerated';
5
5
  import { IMonetaryAmount } from '../monetaryAmount';
6
6
  import { ITotalPaymentDue } from '../order';
7
7
  import { ICreditCard3DS, IUnauthorizedCardOfMember, IUncheckedCardRaw, IUncheckedCardTokenized } from '../paymentMethod/paymentCard/creditCard';
8
- import { IOnPaymentStatusChanged } from '../product';
9
8
  import { IPropertyValue } from '../propertyValue';
10
- import { PaymentServiceType } from '../service/paymentService';
11
- export import IAgent = AssetTransactionFactory.IAgent;
9
+ import { IPotentialAction as IPotentialInformAction, PaymentServiceType } from '../service/paymentService';
10
+ export import IAgent = AssetTransactionFactory.IAgentAsSeller;
12
11
  export type IRecipient = IPayRecipient;
13
12
  /**
14
13
  * ペイメントカードトークン
@@ -88,7 +87,6 @@ export interface IObject {
88
87
  */
89
88
  id: string;
90
89
  paymentMethod: IPaymentMethod;
91
- onPaymentStatusChanged?: IOnPaymentStatusChanged;
92
90
  pendingTransaction?: IPendingTransaction;
93
91
  accountsReceivablesByServiceType?: never;
94
92
  /**
@@ -108,14 +106,25 @@ export interface IPaymentMethodWithoutDetail extends IPaymentMethod {
108
106
  export interface IObjectWithoutDetail extends Pick<IObject, 'typeOf' | 'id' | 'paymentMethod'> {
109
107
  paymentMethod: IPaymentMethodWithoutDetail;
110
108
  }
109
+ export type IPotentialAction = IPotentialInformAction;
110
+ export type IOrderAsPurpose = IOrderAsPayPurpose;
111
+ export type IPurpose = IOrderAsPurpose;
111
112
  export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.Pay, IAgent, IRecipient, IObjectWithoutDetail> & {
112
113
  location?: ILocation;
113
114
  recipient: IRecipient;
114
- purpose?: IPayPurpose;
115
+ /**
116
+ * required(2025-02-12~)
117
+ */
118
+ purpose: IPurpose;
115
119
  };
116
120
  export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.Pay, IAgent, IRecipient, IObject> {
117
121
  location?: ILocation;
118
122
  recipient: IRecipient;
123
+ potentialAction?: IPotentialAction[];
124
+ /**
125
+ * add(2025-02-18~)
126
+ */
127
+ instrument?: IInstrument[];
119
128
  }
120
129
  export interface IOptimizedPayAction4order {
121
130
  object: {
@@ -159,6 +168,7 @@ export interface IConfirmParams {
159
168
  export type IResult = any;
160
169
  export type IError = any;
161
170
  export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
171
+ potentialAction?: IPotentialAction[];
162
172
  }
163
173
  export type ITransaction = IExtendId<IAttributes>;
164
174
  export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.Pay> {