@chevre/factory 3.1.0 → 3.343.0-alpha.2

package/lib/additionalProperty.d.ts

@@ -0,0 +1,66 @@
+import { ICategoryCode } from './categoryCode';
+import { CreativeWorkType } from './creativeWorkType';
+import { EventType } from './eventType';
+import { IMultilingualString } from './multilingualString';
+import { IOfferCatalog } from './offerCatalog';
+import { OfferType } from './offerType';
+import { OrderType } from './order';
+import { PlaceType } from './placeType';
+import { IProject } from './project';
+import { PropertyValueType } from './propertyValue';
+import { ISeller } from './seller';
+import { SortType } from './sortType';
+import { IThing } from './thing';
+export type CategoryCodeType = ICategoryCode['typeOf'];
+export type OfferCatalogType = IOfferCatalog['typeOf'];
+export type SellerType = ISeller['typeOf'];
+export type CategorySetIdentifier = CategoryCodeType | CreativeWorkType.Movie | EventType.ScreeningEvent | EventType.ScreeningEventSeries | PropertyValueType.LocationFeatureSpecification | OfferCatalogType | OfferType.Offer | OrderType.Order | PlaceType.MovieTheater | SellerType;
+/**
+ * {@link https://schema.org/CategoryCodeSet}
+ */
+export interface ICategoryCodeSet {
+    typeOf: 'CategoryCodeSet';
+    identifier: CategorySetIdentifier;
+}
+/**
+ * {@link https://schema.org/CategoryCode}
+ */
+export interface IAdditionalProperty extends Pick<IThing, 'name'> {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    id?: string;
+    typeOf: 'CategoryCode';
+    codeValue: string;
+    inCodeSet: ICategoryCodeSet;
+    name: IMultilingualString;
+}
+/**
+ * 検索条件
+ */
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: {
+        codeValue?: SortType;
+    };
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    id?: {
+        $eq?: string;
+    };
+    name?: {
+        $regex?: string;
+    };
+    codeValue?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    inCodeSet?: {
+        identifier?: {
+            $eq?: string;
+            $in?: string[];
+        };
+    };
+}

package/lib/assetTransaction/cancelReservation.d.ts

@@ -0,0 +1,69 @@
+import { IAttributes as ICancelReservationActionAttributes } from '../action/cancel/reservation';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { ITransaction as IReserveTransaction } from '../assetTransaction/reserve';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { IClientUser } from '../clientUser';
+import { IReservation as IBusReservation, IReservationFor as IBusReservationFor } from '../reservation/busReservation';
+import { IReservation as IEventReservation, IReservationFor as IEventReservationFor } from '../reservation/event';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.CancelReservation, IAgent, undefined, IObjectWithoutDetail>;
+/**
+ * 取引開始パラメータ
+ */
+export type IStartParams = AssetTransactionFactory.IStartParams<AssetTransactionType.CancelReservation, IAgent, undefined, IObject>;
+export interface IResult {
+}
+/**
+ * エラー
+ */
+export type IError = any;
+export interface IObjectWithoutDetail {
+    clientUser?: IClientUser;
+    reservation?: {
+        /**
+         * 予約IDをキーに取消
+         */
+        id?: string;
+        /**
+         * 予約番号をキーに取消
+         */
+        reservationNumber?: string;
+    };
+}
+export type IReserveTransactionAsObject = Pick<IReserveTransaction, 'typeOf' | 'id' | 'transactionNumber'> & {
+    object: {
+        reservationFor: Pick<IEventReservationFor | IBusReservationFor, 'id' | 'typeOf'>;
+    };
+};
+export type IBusReservationAsObject = Pick<IBusReservation, 'id' | 'issuedThrough' | 'reservationNumber' | 'typeOf'> & {
+    reservationFor: Pick<IBusReservationFor, 'id' | 'typeOf'>;
+};
+export type IEventReservationAsObject = Pick<IEventReservation, 'id' | 'issuedThrough' | 'reservationNumber' | 'typeOf'> & {
+    reservationFor: Pick<IEventReservationFor, 'id' | 'typeOf'>;
+};
+/**
+ * 取引対象物
+ */
+export interface IObject {
+    clientUser?: IClientUser;
+    transaction?: IReserveTransactionAsObject;
+    reservations?: IBusReservationAsObject[] | IEventReservationAsObject[];
+}
+/**
+ * 取引確定パラメータ
+ */
+export interface IConfirmParams {
+    id: string;
+}
+export interface IPotentialActions {
+    cancelReservation: ICancelReservationActionAttributes[];
+}
+export type ITransaction = IExtendId<IAttributes>;
+/**
+ * 取引属性
+ */
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.CancelReservation> {
+}

package/lib/assetTransaction/moneyTransfer.d.ts

@@ -0,0 +1,136 @@
+import { IAmount as IMoneyTransferAmount, IAttributes as IMoneyTransferActionAttributes, ILocation, IPendingTransaction, IRecipient as IMoneyTransferRecipient } from '../action/transfer/moneyTransfer';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { OrderType } from '../order';
+import { PermitType } from '../permit';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IRecipient = IMoneyTransferRecipient & {
+    name: string;
+};
+export type IFromLocation = ILocation;
+export type IToLocation = ILocation;
+/**
+ * ペイメントカード
+ */
+export interface IPaymentCard {
+    typeOf: PermitType;
+    identifier: string;
+    accessCode?: string;
+    hasNoPermit?: boolean;
+    issuedThrough: {
+        /**
+         * カード発行サービスID
+         */
+        id: string;
+    };
+}
+/**
+ * トークン化されたペイメントカードンターフェース
+ */
+export type ITokenizedPaymentCard = string;
+/**
+ * 転送元としての注文
+ */
+export interface IOrderAsFromLocation {
+    typeOf: OrderType;
+    confirmationNumber: string;
+    orderNumber: string;
+}
+export type IFromLocationBeforeStart = IOrderAsFromLocation | IPaymentCard | ITokenizedPaymentCard;
+export type IToLocationBeforeStart = IOrderAsFromLocation | IPaymentCard;
+/**
+ * 取引対象物
+ */
+export interface IObject {
+    /**
+     * 金額
+     */
+    amount: IMoneyTransferAmount;
+    /**
+     * 転送元
+     */
+    fromLocation: IFromLocation;
+    /**
+     * 転送先
+     */
+    toLocation: IToLocation;
+    /**
+     * 取引説明
+     */
+    description?: string;
+    pendingTransaction: IPendingTransaction;
+    /**
+     * 負の残高でも強制的に出金するかどうか
+     */
+    force?: boolean;
+}
+export type IObjectWithoutDetail = IObject;
+export interface IObjectBeforeStart {
+    /**
+     * 金額
+     */
+    amount: IMoneyTransferAmount;
+    /**
+     * 転送元
+     */
+    fromLocation: IFromLocation | IFromLocationBeforeStart;
+    /**
+     * 転送先
+     */
+    toLocation: IToLocation | IToLocationBeforeStart;
+    /**
+     * 取引説明
+     */
+    description?: string;
+    /**
+     * 口座取引タイプの確認ために指定
+     */
+    pendingTransaction: Pick<IPendingTransaction, 'typeOf'>;
+    /**
+     * 負の残高でも強制的に出金するかどうか
+     */
+    force?: boolean;
+}
+export interface IStartParamsWithoutDetail extends AssetTransactionFactory.IStartParams<AssetTransactionType.MoneyTransfer, IAgent, IRecipient, IObjectWithoutDetail> {
+    recipient: IRecipient;
+}
+export interface IStartParamsBeforeStart extends AssetTransactionFactory.IStartParams<AssetTransactionType.MoneyTransfer, IAgent, IRecipient, IObjectBeforeStart> {
+    recipient: IRecipient;
+}
+export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.MoneyTransfer, IAgent, IRecipient, IObject> {
+    recipient: IRecipient;
+}
+export type IResult = any;
+export type IError = any;
+export interface IPotentialActions {
+    /**
+     * 通貨転送アクション
+     */
+    moneyTransfer: IMoneyTransferActionAttributes[];
+}
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+/**
+ * 転送取引
+ */
+export type ITransaction = IExtendId<IAttributes>;
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.MoneyTransfer> {
+    object?: {
+        fromLocation?: {
+            identifier?: {
+                $eq?: string;
+            };
+        };
+        toLocation?: {
+            identifier?: {
+                $eq?: string;
+            };
+        };
+        pendingTransaction?: {
+            identifier?: {
+                $eq?: string;
+            };
+        };
+    };
+}

package/lib/assetTransaction/pay.d.ts

@@ -0,0 +1,157 @@
+import * as GMO from '@motionpicture/gmo-service';
+import { IAction as IPayAction, IAttributes as IPayActionAttributes, ILocation, IMovieTicket, IOrderAsPayPurpose, IPendingTransaction, IPurpose as IPayPurpose, IRecipient as IPayRecipient } from '../action/trade/pay';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { IMonetaryAmount } from '../monetaryAmount';
+import { ITotalPaymentDue } from '../order';
+import { IUnauthorizedCardOfMember, IUncheckedCardRaw, IUncheckedCardTokenized } from '../paymentMethod/paymentCard/creditCard';
+import { IOnPaymentStatusChanged } from '../project';
+import { IPropertyValue } from '../propertyValue';
+import { PaymentServiceType } from '../service/paymentService';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IRecipient = IPayRecipient;
+/**
+ * ペイメントカードトークン
+ */
+export type ITokenizedPaymentCard = string;
+export type IFromLocation = ITokenizedPaymentCard;
+/**
+ * クレジットカード決済承認に必要なクレジットカードインターフェース
+ */
+export declare type ICreditCard = IUncheckedCardRaw | IUncheckedCardTokenized | IUnauthorizedCardOfMember;
+export import IEntryTranArgs = GMO.factory.credit.IEntryTranArgs;
+export import IEntryTranResult = GMO.factory.credit.IEntryTranResult;
+export import IExecTranArgs = GMO.factory.credit.IExecTranArgs;
+export import IExecTranResult = GMO.factory.credit.IExecTranResult;
+export interface IPaymentMethodAmount extends Pick<IMonetaryAmount, 'currency' | 'typeOf' | 'value'> {
+    value: number;
+}
+export interface IPaymentMethod {
+    /**
+     * The identifier for the account the payment will be applied to.
+     */
+    accountId?: string;
+    /**
+     * 追加特性
+     */
+    additionalProperty?: IPropertyValue<string>[];
+    /**
+     * The amount of money.
+     * MonetaryAmount対応(2023-08-12~)
+     */
+    amount: number | IPaymentMethodAmount;
+    /**
+     * 説明
+     */
+    description?: string;
+    /**
+     * 決済方法名称
+     * 未指定であればデフォルト値が使用されます
+     */
+    name?: string;
+    /**
+     * The total amount due.
+     */
+    totalPaymentDue?: ITotalPaymentDue;
+    /**
+     * 決済方法区分
+     */
+    identifier: string;
+    /**
+     * 出金元ペイメントカード
+     */
+    fromLocation?: IFromLocation;
+    /**
+     * ムビチケリスト
+     */
+    movieTickets?: IMovieTicket[];
+    /**
+     * 支払い方法
+     */
+    method?: string;
+    /**
+     * クレジットカード情報
+     */
+    creditCard?: ICreditCard;
+}
+export interface IAccountsReceivableByServiceType {
+    serviceType: string;
+    accountsReceivable?: number;
+}
+/**
+ * 取引対象物
+ */
+export interface IObject {
+    accountId: string;
+    paymentMethodId: string;
+    typeOf: PaymentServiceType;
+    /**
+     * 発行決済サービスID
+     */
+    id: string;
+    paymentMethod: IPaymentMethod;
+    pendingTransaction?: IPendingTransaction;
+    entryTranArgs?: IEntryTranArgs;
+    entryTranResult?: IEntryTranResult;
+    execTranArgs?: IExecTranArgs;
+    execTranResult?: IExecTranResult;
+    payAction?: IPayAction;
+    onPaymentStatusChanged?: IOnPaymentStatusChanged;
+    accountsReceivablesByServiceType?: IAccountsReceivableByServiceType[];
+}
+export interface IPaymentMethodWithoutDetail extends IPaymentMethod {
+    /**
+     * 取引開始前の指定ではnumberに限定
+     */
+    amount: number;
+}
+export interface IObjectWithoutDetail extends Pick<IObject, 'typeOf' | 'id' | 'paymentMethod'> {
+    paymentMethod: IPaymentMethodWithoutDetail;
+}
+export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.Pay, IAgent, IRecipient, IObjectWithoutDetail> & {
+    location?: ILocation;
+    recipient: IRecipient;
+    purpose?: IPayPurpose;
+};
+export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.Pay, IAgent, IRecipient, IObject> {
+    location?: ILocation;
+    recipient: IRecipient;
+}
+export interface IPotentialActions {
+    /**
+     * 決済アクション
+     */
+    pay: IPayActionAttributes[];
+}
+export interface IPotentialActionsParams {
+    pay: {
+        purpose: IOrderAsPayPurpose;
+    };
+}
+/**
+ * 確定パラメータ
+ */
+export interface IConfirmParams {
+    id?: string;
+    object?: {
+        paymentMethod?: {
+            identifier?: string;
+        };
+    };
+    transactionNumber?: string;
+    endDate?: Date;
+    potentialActions: IPotentialActionsParams;
+}
+export type IResult = any;
+export type IError = any;
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+export type ITransaction = IExtendId<IAttributes>;
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.Pay> {
+    object?: {
+        accountId?: {
+            $eq?: string;
+        };
+    };
+}

package/lib/assetTransaction/refund.d.ts

@@ -0,0 +1,68 @@
+import { IPaymentMethod, IReturnActionAsPayPurpose } from '../action/trade/pay';
+import { IAttributes as IRefundActionAttributes, IRecipient as IRefundRecipient } from '../action/trade/refund';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { IOnPaymentStatusChanged } from '../project';
+import { PaymentServiceType } from '../service/paymentService';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IRecipient = IRefundRecipient;
+/**
+ * 取引対象物
+ */
+export interface IObject {
+    accountId: string;
+    paymentMethodId: string;
+    typeOf: PaymentServiceType;
+    /**
+     * 発行決済サービスID
+     */
+    id: string;
+    onPaymentStatusChanged?: IOnPaymentStatusChanged;
+    paymentMethod: IPaymentMethod;
+    refundFee?: number;
+}
+export type IObjectWithoutDetail = Pick<IObject, 'typeOf' | 'id' | 'paymentMethod' | 'refundFee'>;
+export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.Refund, IAgent, IRecipient, IObjectWithoutDetail>;
+export interface IStartParams extends AssetTransactionFactory.IStartParams<AssetTransactionType.Refund, IAgent, IRecipient, IObject> {
+}
+export type IRefundPurpose = IReturnActionAsPayPurpose;
+export interface IPotentialActionsParams {
+    refund?: {
+        purpose?: IRefundPurpose;
+    };
+}
+/**
+ * 確定パラメータ
+ */
+export interface IConfirmParams {
+    id?: string;
+    transactionNumber?: string;
+    endDate?: Date;
+    potentialActions?: IPotentialActionsParams;
+}
+export type IResult = any;
+export type IError = any;
+export interface IPotentialActions {
+    /**
+     * 返金アクション
+     */
+    refund: IRefundActionAttributes[];
+}
+export type ITransaction = IExtendId<IAttributes>;
+/**
+ * 返金取引
+ */
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.Refund> {
+    object?: {
+        accountId?: {
+            $eq?: string;
+        };
+        paymentMethodId?: {
+            $eq?: string;
+            $in?: string[];
+        };
+    };
+}

package/lib/assetTransaction/registerService.d.ts

@@ -0,0 +1,103 @@
+import { IAttributes as IRegisterServiceActionAttributes } from '../action/interact/register/service';
+import { IAttributes as IMoneyTransferActionAttributes, IPointAward } from '../action/transfer/moneyTransfer';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { OfferType } from '../offerType';
+import { IIssuedThroughAsProduct, IPermit } from '../permit';
+import { IProduct } from '../product';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.RegisterService, IAgent, undefined, IObjectWithoutDetail>;
+/**
+ * 取引開始パラメーター
+ * サービス: MembershipService,PaymentCardであればserviceOutputを発行する
+ */
+export type IStartParams = AssetTransactionFactory.IStartParams<AssetTransactionType.RegisterService, IAgent, undefined, IObject>;
+/**
+ * 確定パラメータ
+ */
+export interface IConfirmParams {
+    id?: string;
+    transactionNumber?: string;
+    /**
+     * 取引確定日時を指定する
+     * serviceOutputのvalidFromに適用される
+     */
+    endDate?: Date;
+}
+export interface IResult {
+}
+/**
+ * エラー
+ */
+export type IError = any;
+export interface IAcceptedPointAward {
+    purpose?: {
+        identifier?: string;
+    };
+    recipient?: any;
+    /**
+     * 特典付与先
+     */
+    toLocation?: {
+        /**
+         * カード番号
+         */
+        identifier: string;
+        issuedThrough: {
+            /**
+             * カード発行サービスID
+             */
+            id: string;
+        };
+    };
+}
+export type IServiceOutput = Omit<IPermit, 'issuedThrough'> & {
+    issuedThrough?: IIssuedThroughAsProduct;
+};
+export interface IAcceptedItemOffered {
+    id?: string;
+    pointAward?: IAcceptedPointAward;
+    serviceOutput?: IServiceOutput;
+}
+export interface IAcceptedOfferWithoutDetail {
+    typeOf: OfferType.Offer;
+    id: string;
+    itemOffered: IAcceptedItemOffered;
+}
+export interface IItemOffered extends Pick<IProduct, 'id' | 'serviceOutput' | 'typeOf'> {
+    serviceOutput: IServiceOutput;
+    pointAward?: IPointAward;
+}
+export interface IAcceptedOffer {
+    typeOf: OfferType.Offer;
+    id: string;
+    itemOffered: IItemOffered;
+}
+export type IObjectWithoutDetail = IAcceptedOfferWithoutDetail[];
+export type IObject = IAcceptedOffer[];
+export interface IPotentialActions {
+    moneyTransfer: IMoneyTransferActionAttributes[];
+    registerService: IRegisterServiceActionAttributes[];
+}
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+/**
+ * 取引
+ */
+export type ITransaction = IExtendId<IAttributes>;
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.RegisterService> {
+    object?: {
+        itemOffered?: {
+            serviceOutput?: {
+                /**
+                 * 発行許可証識別子
+                 */
+                identifier?: {
+                    $eq?: string;
+                    $in?: string[];
+                };
+            };
+        };
+    };
+}