@chevre/factory 3.1.0 → 3.343.0-alpha.2

package/lib/assetTransaction/reserve.d.ts

@@ -0,0 +1,298 @@
+import * as ReserveActionFactory from '../action/reserve';
+import { IPointAward } from '../action/transfer/moneyTransfer';
+import { ActionType } from '../actionType';
+import * as AssetTransactionFactory from '../assetTransaction';
+import { AssetTransactionType } from '../assetTransactionType';
+import { IExtendId } from '../autoGenerated';
+import { IPropertyValue } from '../propertyValue';
+import * as ReservationFactory from '../reservation';
+import { IIssuedThrough as IBusReservationIssuedThrough, IReservation as IBusReservation, IReservationFor as IBusReservationReservationFor } from '../reservation/busReservation';
+import { IIssuedThrough as IEventReservationIssuedThrough, IReservation as IEventReservation, IReservationFor as IEventReservationReservationFor, ISubReservation as ISubReservation4eventReservation } from '../reservation/event';
+import { IReservation as IReservationPackage } from '../reservation/reservationPackage';
+import { ReservationType } from '../reservationType';
+import { IUnitPriceOffer } from '../unitPriceOffer';
+export import IAgent = AssetTransactionFactory.IAgent;
+export type IStartParamsWithoutDetail = AssetTransactionFactory.IStartParams<AssetTransactionType.Reserve, IAgent, undefined, IObjectWithoutDetail>;
+/**
+ * 取引開始パラメータ
+ */
+export type IStartParams = AssetTransactionFactory.IStartParams<AssetTransactionType.Reserve, IAgent, undefined, IObject>;
+export interface IAcceptedProgramMembershipUsedAsObject {
+    accessCode?: string;
+    /**
+     * メンバーシップコード
+     */
+    identifier: string;
+    issuedThrough: {
+        /**
+         * メンバーシップ発行サービスID
+         */
+        id: string;
+    };
+}
+/**
+ * トークン化された適用メンバーシップ
+ */
+export type ITokenizedAcceptedProgramMembershipUsed = string;
+/**
+ * 適用メンバーシップ
+ */
+export type IAcceptedProgramMembershipUsed = IAcceptedProgramMembershipUsedAsObject | ITokenizedAcceptedProgramMembershipUsed;
+export type IAcceptedSubReservation = ISubReservation4eventReservation;
+export interface IAcceptedPointAward {
+    typeOf: ActionType.MoneyTransfer;
+    recipient?: any;
+    /**
+     * 特典付与先
+     */
+    toLocation?: {
+        /**
+         * カード番号
+         */
+        identifier: string;
+        issuedThrough: {
+            /**
+             * カード発行サービスID
+             */
+            id: string;
+        };
+    };
+}
+export interface IBusReservatonAsItemOfferedServiceOutput {
+    typeOf: ReservationType.BusReservation;
+    /**
+     * 追加特性
+     */
+    additionalProperty?: IPropertyValue<string>[];
+    /**
+     * 予約追加テキスト
+     */
+    additionalTicketText?: string;
+    programMembershipUsed?: IAcceptedProgramMembershipUsed;
+    reservedTicket?: {
+        issuedBy?: ReservationFactory.IUnderName;
+        typeOf: ReservationFactory.TicketType;
+        /**
+         * 予約座席指定
+         * 指定席イベントの場合、座席を指定
+         * 自由席イベントの場合、あるいは、最大収容人数がないイベントの場合は、座席指定不要
+         */
+        ticketedSeat?: ReservationFactory.ISeat;
+    };
+    subReservation?: IAcceptedSubReservation[];
+}
+export interface IEventReservatonAsItemOfferedServiceOutput {
+    typeOf: ReservationType.EventReservation;
+    /**
+     * 追加特性
+     */
+    additionalProperty?: IPropertyValue<string>[];
+    /**
+     * 予約追加テキスト
+     */
+    additionalTicketText?: string;
+    programMembershipUsed?: IAcceptedProgramMembershipUsed;
+    reservedTicket?: {
+        issuedBy?: ReservationFactory.IUnderName;
+        typeOf: ReservationFactory.TicketType;
+        /**
+         * 予約座席指定
+         * 指定席イベントの場合、座席を指定
+         * 自由席イベントの場合、あるいは、最大収容人数がないイベントの場合は、座席指定不要
+         */
+        ticketedSeat?: ReservationFactory.ISeat;
+    };
+    subReservation?: IAcceptedSubReservation[];
+}
+export type IItemOfferedServiceOutput = IBusReservatonAsItemOfferedServiceOutput | IEventReservatonAsItemOfferedServiceOutput;
+/**
+ * 受け入れられたオファーのアイテム
+ */
+export interface IAcceptedTicketOfferItemOffered {
+    pointAward?: IAcceptedPointAward;
+    serviceOutput?: IItemOfferedServiceOutput;
+}
+export interface IAcceptedTicketOfferItemOffered4object {
+    pointAward?: IPointAward;
+    serviceOutput: {
+        id: string;
+    };
+}
+/**
+ * 予約取引開始時の受入アドオンオファー
+ */
+export interface IAcceptedAddOn extends Pick<IUnitPriceOffer, 'id'> {
+    /**
+     * アドオン単価オファーID
+     */
+    id?: string;
+    priceSpecification?: {
+        referenceQuantity?: {
+            /**
+             * 数量指定(2023-08-31~)
+             * 単価オファーの基準数量で割り切れる必要あり
+             */
+            value?: number;
+        };
+    };
+}
+export interface ISingleAcceptedAppliesToMovieTicket {
+    /**
+     * 適用決済カード識別子
+     */
+    identifier?: string;
+}
+/**
+ * 複数承認適用決済カード
+ * 複数指定の場合、カード識別子と決済方法区分の組み合わせで指定します
+ */
+export type IMultipleAcceptedAppliesToMovieTicket = {
+    /**
+     * 適用決済カード識別子
+     */
+    identifier?: string;
+    serviceOutput?: {
+        /**
+         * 決済方法区分
+         */
+        typeOf?: string;
+    };
+}[];
+/**
+ * 承認適用決済カード
+ */
+export type IAcceptedAppliesToMovieTicket = ISingleAcceptedAppliesToMovieTicket | IMultipleAcceptedAppliesToMovieTicket;
+/**
+ * 受け入れられたチケットオファー(詳細なし)
+ */
+export interface IAcceptedTicketOfferWithoutDetail {
+    /**
+     * オファーID
+     */
+    id: string;
+    /**
+     * アイテム情報
+     * 予約の詳細指定など
+     */
+    itemOffered?: IAcceptedTicketOfferItemOffered;
+    /**
+     * 受入アドオン
+     */
+    addOn?: IAcceptedAddOn[];
+    additionalProperty?: IPropertyValue<string>[];
+    priceSpecification?: {
+        appliesToMovieTicket?: IAcceptedAppliesToMovieTicket;
+    };
+}
+/**
+ * 受け入れられたチケットオファー
+ */
+export interface IAcceptedOffer4object {
+    id: string;
+    itemOffered: IAcceptedTicketOfferItemOffered4object;
+    priceSpecification?: {
+        appliesToMovieTicket?: IAcceptedAppliesToMovieTicket;
+    };
+}
+export interface IPotentialActionsParams {
+    reserve?: {
+        purpose?: ReserveActionFactory.IOrderAsReservePurpose;
+    };
+}
+/**
+ * 確定パラメータ
+ */
+export interface IConfirmParams {
+    id?: string;
+    transactionNumber?: string;
+    potentialActions?: IPotentialActionsParams;
+}
+export interface IResult {
+}
+/**
+ * エラー
+ */
+export type IError = any;
+export interface IObjectWithoutDetail {
+    acceptedOffer?: IAcceptedTicketOfferWithoutDetail[];
+    broker?: ReservationFactory.IBroker;
+    reservationFor?: {
+        id: string;
+    };
+}
+export type IReservationFor = IBusReservationReservationFor | IEventReservationReservationFor;
+export type IOmittedReservationProperty = 'reservationFor' | 'broker' | 'issuedThrough' | 'provider' | 'reservationStatus';
+export type IObjectSubReservation = Omit<IBusReservation, IOmittedReservationProperty> | Omit<IEventReservation, IOmittedReservationProperty>;
+export type IObjectSubReservationReservedTicket = Pick<ReservationFactory.ITicket, 'issuedBy' | 'ticketedSeat' | 'ticketType'>;
+export type IMinimizedObjectSubReservation = Pick<IObjectSubReservation, 'typeOf' | 'id' | 'subReservation'> & {
+    reservedTicket: IObjectSubReservationReservedTicket;
+};
+export type IIssuedThrough = IBusReservationIssuedThrough | IEventReservationIssuedThrough;
+/**
+ * 取引対象物
+ */
+export interface IObject extends Pick<IReservationPackage, 'broker' | 'provider' | 'reservationStatus' | 'underName' | 'typeOf'> {
+    acceptedOffer?: IAcceptedOffer4object[];
+    issuedThrough?: IIssuedThrough;
+    reservationFor?: IReservationFor;
+    reservationNumber: string;
+    subReservation?: IObjectSubReservation[];
+    /**
+     * trueで固定(2023-07-19~)
+     */
+    disablePendingReservations: true;
+    useHoldStockByTransactionNumber?: boolean;
+}
+export interface IPotentialActions {
+    reserve: ReserveActionFactory.IAttributes[];
+}
+export interface IAttributes extends AssetTransactionFactory.IAttributes<IStartParams, IResult, IError, IPotentialActions> {
+}
+/**
+ * 予約取引
+ */
+export type ITransaction = IExtendId<IAttributes>;
+export interface IObjectSearchConditions {
+    provider?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    reservationFor?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    reservationNumber?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    reservations?: {
+        id?: {
+            $in?: string[];
+        };
+        reservationNumber?: {
+            $in?: string[];
+        };
+        reservationFor?: {
+            id?: {
+                $in?: string[];
+            };
+        };
+        reservedTicket?: {
+            ticketedSeat?: {
+                seatNumber?: {
+                    $eq?: string;
+                };
+            };
+        };
+    };
+    underName?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+}
+export interface ISearchConditions extends AssetTransactionFactory.ISearchConditions<AssetTransactionType.Reserve> {
+    object?: IObjectSearchConditions;
+}

package/lib/assetTransaction.d.ts

@@ -0,0 +1,176 @@
+import { AssetTransactionType } from './assetTransactionType';
+import { IExtendId } from './autoGenerated';
+import { OrganizationType } from './organizationType';
+import { PersonType } from './personType';
+import { SortType } from './sortType';
+import { IIdentifier } from './thing';
+import { TransactionStatusType } from './transactionStatusType';
+import { TransactionTasksExportationStatus } from './transactionTasksExportationStatus';
+/**
+ * 販売者主体
+ */
+export interface IAgentAsSeller {
+    typeOf: OrganizationType.Corporation;
+    id: string;
+    /**
+     * 名称は必須
+     */
+    name: string;
+    identifier?: IIdentifier;
+}
+/**
+ * 管理者主体
+ */
+export interface IAgentAsPerson {
+    typeOf: PersonType.Person;
+    id: string;
+    /**
+     * 名称は必須
+     */
+    name: string;
+    identifier?: IIdentifier;
+}
+/**
+ * 資産取引主体は販売者or管理者
+ */
+export type IAgent = IAgentAsSeller | IAgentAsPerson;
+export interface IProject {
+    id: string;
+    typeOf: OrganizationType.Project;
+}
+export interface ITasksExportAction {
+    agent?: {
+        name: string;
+    };
+    startDate: Date;
+    endDate?: Date;
+}
+/**
+ * 資産取引開始パラメータ
+ */
+export interface IStartParams<T extends AssetTransactionType, TAgent extends IAgent, TRecipient, TObject> {
+    project: IProject;
+    /**
+     * 取引タイプ
+     */
+    typeOf: T;
+    /**
+     * 取引識別子
+     */
+    identifier?: string;
+    /**
+     * 取引番号
+     */
+    transactionNumber: string;
+    /**
+     * 取引主体
+     */
+    agent: TAgent;
+    /**
+     * 取引物受取者
+     */
+    recipient?: TRecipient;
+    /**
+     * 取引対象
+     */
+    object: TObject;
+    /**
+     * 取引進行期限
+     */
+    expires: Date;
+}
+/**
+ * 資産取引属性
+ */
+export type IAttributes<TStartParams, TResult, TError, TPotentialActions> = TStartParams & {
+    purpose?: any;
+    /**
+     * 取引状態
+     */
+    status: TransactionStatusType;
+    /**
+     * 取引結果
+     */
+    result?: TResult;
+    /**
+     * 取引エラー
+     */
+    error?: TError;
+    /**
+     * 取引開始日時
+     */
+    startDate: Date;
+    /**
+     * 取引終了日時
+     */
+    endDate?: Date;
+    tasksExportAction?: ITasksExportAction;
+    /**
+     * タスクエクスポート日時
+     */
+    tasksExportedAt?: Date;
+    /**
+     * タスクエクスポート状態
+     */
+    tasksExportationStatus: TransactionTasksExportationStatus;
+    /**
+     * 事後に発生するアクション
+     */
+    potentialActions?: TPotentialActions;
+};
+/**
+ * 資産取引
+ */
+export type ITransaction<TStartParams, TResult, TError, TPotentialActions> = IExtendId<IAttributes<TStartParams, TResult, TError, TPotentialActions>>;
+/**
+ * ソート条件
+ */
+export interface ISortOrder {
+    startDate?: SortType;
+}
+export interface ISearchConditions<T extends AssetTransactionType> {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    /**
+     * 取引タイプ
+     */
+    typeOf: T;
+    /**
+     * IDリスト
+     */
+    ids?: string[];
+    /**
+     * ステータスリスト
+     */
+    statuses?: TransactionStatusType[];
+    /**
+     * 開始日時(から)
+     */
+    startFrom?: Date;
+    /**
+     * 開始日時(まで)
+     */
+    startThrough?: Date;
+    /**
+     * 終了日時(から)
+     */
+    endFrom?: Date;
+    /**
+     * 終了日時(まで)
+     */
+    endThrough?: Date;
+    agent?: {
+        ids?: string[];
+    };
+    transactionNumber?: {
+        $eq?: string;
+        $in?: string[];
+    };
+    tasksExportationStatuses?: TransactionTasksExportationStatus[];
+}

package/lib/assetTransactionType.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 資産取引タイプ
+ */
+export declare enum AssetTransactionType {
+    /**
+     * 通貨転送
+     */
+    MoneyTransfer = "MoneyTransfer",
+    /**
+     * 予約
+     */
+    Reserve = "Reserve",
+    /**
+     * 予約キャンセル
+     */
+    CancelReservation = "CancelReservation",
+    /**
+     * 決済
+     * PaymentMethod: PaymentCard,CreditCard...
+     */
+    Pay = "Pay",
+    /**
+     * 返金
+     */
+    Refund = "Refund",
+    /**
+     * サービス登録
+     * Service: MembershipService,PaymentCard...
+     */
+    RegisterService = "RegisterService"
+}

package/lib/assetTransactionType.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetTransactionType = void 0;
+/**
+ * 資産取引タイプ
+ */
+var AssetTransactionType;
+(function (AssetTransactionType) {
+    /**
+     * 通貨転送
+     */
+    AssetTransactionType["MoneyTransfer"] = "MoneyTransfer";
+    /**
+     * 予約
+     */
+    AssetTransactionType["Reserve"] = "Reserve";
+    /**
+     * 予約キャンセル
+     */
+    AssetTransactionType["CancelReservation"] = "CancelReservation";
+    /**
+     * 決済
+     * PaymentMethod: PaymentCard,CreditCard...
+     */
+    AssetTransactionType["Pay"] = "Pay";
+    /**
+     * 返金
+     */
+    AssetTransactionType["Refund"] = "Refund";
+    /**
+     * サービス登録
+     * Service: MembershipService,PaymentCard...
+     */
+    AssetTransactionType["RegisterService"] = "RegisterService";
+})(AssetTransactionType = exports.AssetTransactionType || (exports.AssetTransactionType = {}));

package/lib/authorization.d.ts

@@ -0,0 +1,61 @@
+import { IOrder } from './order';
+import { IOwnershipInfo, IPermitAsGood, IPermitIssuedThrough, IReservation } from './ownershipInfo';
+import { IProject } from './project';
+import { SortType } from './sortType';
+export type IOrderAsObject = Pick<IOrder, 'orderNumber' | 'typeOf'>;
+export type IPermitIssuedThroughOfObjectTypeOfGood = Pick<IPermitIssuedThrough, 'id' | 'typeOf'>;
+export type IPermitAsObjectTypeOfGood = Pick<IPermitAsGood, 'identifier' | 'typeOf'> & {
+    issuedThrough?: IPermitIssuedThroughOfObjectTypeOfGood;
+};
+export type IPermitOwnershipInfoAsObject = Pick<IOwnershipInfo<IPermitAsObjectTypeOfGood>, 'id' | 'identifier' | 'typeOf' | 'typeOfGood'>;
+export type IReservationOwnershipInfoAsObject = Pick<IOwnershipInfo<IReservation>, 'id' | 'identifier' | 'typeOf' | 'typeOfGood'>;
+export type IOwnershipInfoAsObject = IPermitOwnershipInfoAsObject | IReservationOwnershipInfoAsObject;
+export type IObject = IOrderAsObject | IOwnershipInfoAsObject;
+/**
+ * 承認
+ */
+export interface IAuthorization {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    typeOf: 'Authorization';
+    code: string;
+    object: IObject;
+    validFrom: Date;
+    validUntil: Date;
+}
+/**
+ * ソート条件
+ */
+export interface ISortOrder {
+    validFrom?: SortType;
+}
+export interface IObjectSearchConditions {
+    typeOfs?: string[];
+    ids?: string[];
+    typeOfGood?: {
+        typeOfs?: string[];
+        ids?: string[];
+    };
+}
+/**
+ * 承認検索条件
+ */
+export interface ISearchConditions {
+    limit?: number;
+    page?: number;
+    sort?: ISortOrder;
+    project?: {
+        id?: {
+            $eq?: string;
+        };
+    };
+    id?: {
+        $in?: string[];
+    };
+    code?: {
+        $in?: string[];
+    };
+    codes?: string[];
+    validFrom?: Date;
+    validThrough?: Date;
+    object?: IObjectSearchConditions;
+}

package/lib/{factory/autoGenerated.d.ts → autoGenerated.d.ts}

@@ -1,6 +1,6 @@
 /**
  * extend ID interface
  */
-export declare type IExtendId<T> = T & {
+export type IExtendId<T> = T & {
     id: string;
 };

package/lib/businessEntityType.d.ts

@@ -0,0 +1,2 @@
+import { ICategoryCode } from './categoryCode';
+export type IBusinessEntityType = Pick<ICategoryCode, 'codeValue' | 'typeOf'>;