@chevre/factory 3.0.1 → 3.343.0-alpha.2

package/lib/transaction/placeOrder.d.ts

@@ -0,0 +1,208 @@
+import * as waiter from '@waiter/factory';
+import { AccountType } from '../accountType';
+import { IObject as IConfirmReservationObject } from '../action/interact/confirm/reservation';
+import { IAttributes as IOrderActionAttributes } from '../action/trade/order';
+import { IObject as IGivePointAwardObject } from '../action/transfer/give/pointAward';
+import { IExtendId } from '../autoGenerated';
+import { IClientUser } from '../clientUser';
+import * as OrderFactory from '../order';
+import { IInformParams, IProject } from '../project';
+import * as WebAPIFactory from '../service/webAPI';
+import * as TransactionFactory from '../transaction';
+import { TransactionType } from '../transactionType';
+/**
+ * 取引人
+ */
+export type IAgent = TransactionFactory.IAgent;
+export type ICustomer = OrderFactory.ICustomer;
+export interface IPaymentMethodByPaymentUrl {
+    /**
+     * 決済方法区分
+     */
+    typeOf: string;
+    paymentMethodId: string;
+    paymentUrl: string;
+    issuedThrough: {
+        /**
+         * 発行決済サービスID
+         */
+        id: string;
+    };
+}
+/**
+ * 注文特典口座
+ */
+export interface IAwardAccount {
+    typeOf: AccountType.Account;
+    accountNumber: string;
+}
+export interface IObject {
+    clientUser?: IClientUser;
+    broker?: OrderFactory.IBroker;
+    customer?: ICustomer;
+    identifier?: OrderFactory.IIdentifier;
+    /**
+     * 確認番号
+     */
+    confirmationNumber?: string;
+    /**
+     * 注文番号
+     */
+    orderNumber?: string;
+    /**
+     * 注文名称
+     */
+    name?: string;
+    /**
+     * 外部ロケーションでの決済情報
+     */
+    paymentMethods?: IPaymentMethodByPaymentUrl;
+    /**
+     * WAITER許可証トークン
+     */
+    passportToken?: waiter.passport.IEncodedPassport;
+    /**
+     * WAITER許可証
+     */
+    passport?: waiter.passport.IPassport;
+    potentialActions?: {
+        givePointAward?: IGivePointAwardParams[];
+    };
+}
+export interface IStartParamsWithoutDetail {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    agent: IAgent;
+    seller: {
+        id: string;
+    };
+    object: {
+        clientUser?: IClientUser;
+        customer?: ICustomer;
+        passport?: TransactionFactory.IPassportBeforeStart;
+        /**
+         * 注文名称
+         */
+        name?: string;
+    };
+}
+export type ISeller = TransactionFactory.ISeller & Pick<OrderFactory.ISeller, 'additionalProperty'>;
+/**
+ * 取引開始パラメーター
+ */
+export interface IStartParams extends Omit<TransactionFactory.IStartParams<TransactionType.PlaceOrder, IAgent, undefined, IObject>, 'expires'> {
+    /**
+     * 販売者
+     */
+    seller: ISeller;
+    expiresInSeconds: number;
+}
+/**
+ * 注文通知パラメータ
+ */
+export type IInformOrderParams = IInformParams;
+/**
+ * 予約確定パラメータ
+ */
+export interface IConfirmReservationParams {
+    /**
+     * 確定対象
+     */
+    object?: IConfirmReservationObject<WebAPIFactory.Identifier>;
+}
+type ISendEmailMessageParams = TransactionFactory.ISendEmailMessageParams;
+/**
+ * インセンティブ付与パラメータ
+ */
+export interface IGivePointAwardParams {
+    object?: IGivePointAwardObject;
+}
+/**
+ * 取引確定後アクションパラメータ
+ */
+export interface IPotentialActionsParams {
+    order?: {
+        potentialActions?: {
+            sendOrder?: {
+                potentialActions?: {
+                    sendEmailMessage?: ISendEmailMessageParams[];
+                };
+            };
+        };
+    };
+}
+/**
+ * 取引結果の注文パラメータ
+ */
+export interface IResultOrderParams {
+    /**
+     * 注文識別子指定
+     */
+    identifier?: OrderFactory.IIdentifier;
+    /**
+     * 注文確認URLのカスタム指定
+     */
+    url?: string;
+}
+/**
+ * 取引結果パラメータ
+ */
+export interface IResultParams {
+    order?: IResultOrderParams;
+}
+/**
+ * 取引確定パラメータ
+ */
+export interface IConfirmParams {
+    /**
+     * 取引ID
+     */
+    id: string;
+    agent?: {
+        id?: string;
+    };
+    /**
+     * 取引確定後アクション
+     */
+    potentialActions?: IPotentialActionsParams;
+    /**
+     * 取引結果
+     */
+    result?: IResultParams;
+}
+/**
+ * 取引結果
+ */
+export interface IResult {
+    /**
+     * 注文
+     */
+    order: OrderFactory.IOrder;
+}
+/**
+ * エラー
+ */
+export type IError = any;
+export interface IPotentialActions {
+    order: IOrderActionAttributes;
+}
+export interface IAttributes extends TransactionFactory.IAttributes<Omit<IStartParams, 'expiresInSeconds'>, IResult, IError, IPotentialActions> {
+}
+/**
+ * 注文取引
+ */
+export type ITransaction = IExtendId<IAttributes>;
+export interface ISearchConditions extends TransactionFactory.ISearchConditions<TransactionType.PlaceOrder> {
+    seller?: {
+        ids?: string[];
+    };
+    object?: {};
+    result?: {
+        order?: {
+            confirmationNumber?: {
+                $eq?: string;
+            };
+            orderNumbers?: string[];
+        };
+    };
+}
+export {};

package/lib/transaction/placeOrder.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/transaction/returnOrder.d.ts

@@ -0,0 +1,183 @@
+import { IAttributes as IReturnOrderActionAttributes } from '../action/transfer/return/order';
+import { IExtendId } from '../autoGenerated';
+import { ICustomerRemorseReturnFeesMovieTicket, IMerchantReturnPolicy, ReturnFeesEnumeration } from '../merchantReturnPolicy';
+import { IOfferItemCondition } from '../offerItemCondition';
+import { IProject } from '../project';
+import * as TransactionFactory from '../transaction';
+import { TransactionType } from '../transactionType';
+export type IAgent = TransactionFactory.IAgent;
+export import ISeller = TransactionFactory.ISeller;
+export type IResult = any;
+export type IError = any;
+/**
+ * 返品理由
+ */
+export declare enum Reason {
+    /**
+     * カスタマー都合での返品
+     */
+    Customer = "Customer",
+    /**
+     * 販売者都合での返品
+     */
+    Seller = "Seller"
+}
+/**
+ * 返品可能な注文
+ */
+export interface IReturnableOrder {
+    confirmationNumber: string;
+    orderNumber: string;
+}
+/**
+ * 注文返品開始パラメータ
+ */
+export interface IStartParamsWithoutDetail {
+    project: Pick<IProject, 'id' | 'typeOf'>;
+    expiresInSeconds?: number;
+    agent: IAgent;
+    object: {
+        order: IReturnableOrder | IReturnableOrder[];
+        reason: Reason;
+    };
+    seller: {
+        id: string;
+    };
+}
+/**
+ * 取引開始パラメータ
+ */
+export interface IStartParams extends Omit<TransactionFactory.IStartParams<TransactionType.ReturnOrder, IAgent, undefined, IObject>, 'expires'> {
+    /**
+     * 販売者
+     */
+    seller: ISeller;
+    expiresInSeconds: number;
+}
+type ISendEmailMessageParams = TransactionFactory.ISendEmailMessageParams;
+/**
+ * 返金アクションカスタムパラメータ
+ */
+export interface IRefundParams {
+    object: {
+        object: {
+            paymentMethod: {
+                /**
+                 * 返金対象決済ID
+                 */
+                paymentMethodId: string;
+            };
+        }[];
+    };
+    potentialActions?: {
+        /**
+         * 返金メールカスタマイズ
+         */
+        sendEmailMessage?: ISendEmailMessageParams;
+    };
+}
+export interface IReturnOrderActionParams {
+    object?: {
+        /**
+         * 返品対象注文番号
+         */
+        orderNumber?: string;
+    };
+    /**
+     * 注文返品後アクション
+     */
+    potentialActions?: {
+        /**
+         * クレジットカード返金アクションについてカスタマイズする場合に指定
+         * 属性名称がrefundCreditCardであるが、全ての決済方法に適用可能
+         */
+        refundCreditCard?: IRefundParams[];
+        /**
+         * ムビチケ着券取消を実行するかどうか
+         */
+        /**
+         * Eメール送信アクション
+         */
+        sendEmailMessage?: ISendEmailMessageParams[];
+    };
+}
+export interface IPotentialActionsParams {
+    /**
+     * 注文返品アクション
+     */
+    returnOrder?: IReturnOrderActionParams | IReturnOrderActionParams[];
+}
+export interface IConfirmParams {
+    /**
+     * 取引ID
+     */
+    id: string;
+    agent?: {
+        id?: string;
+    };
+    /**
+     * 取引確定後アクション
+     */
+    potentialActions?: IPotentialActionsParams;
+}
+export interface IReturnFeesMovieTicket {
+    /**
+     * 決済カードコード
+     */
+    identifier: string;
+    /**
+     * 着券取消実行有無
+     */
+    returnFees: ICustomerRemorseReturnFeesMovieTicket;
+    serviceOutput: {
+        /**
+         * 決済方法区分
+         */
+        typeOf: string;
+    };
+}
+export type IReturnPolicyItemCondition = IOfferItemCondition;
+/**
+ * 取引に適用される返品ポリシー
+ */
+export type IReturnPolicy = Pick<IMerchantReturnPolicy, 'typeOf' | 'merchantReturnDays' | 'restockingFee' | 'returnFees' | 'applicablePaymentMethod'> & {
+    returnFees: ReturnFeesEnumeration;
+    /**
+     * 決済カードコードごとの着券取消実行有無
+     */
+    returnFeesMovieTicket?: IReturnFeesMovieTicket[];
+    itemCondition?: IReturnPolicyItemCondition;
+};
+/**
+ * 取引対象物
+ */
+export interface IObject {
+    order: IReturnableOrder[];
+    reason: Reason;
+    returnPolicy: IReturnPolicy;
+}
+export type IReturnOrderPotentialAction = Pick<IReturnOrderActionAttributes, 'agent' | 'object' | 'potentialActions' | 'typeOf'>;
+export interface IPotentialActions {
+    /**
+     * 注文返品アクション属性
+     */
+    returnOrder: IReturnOrderPotentialAction[];
+}
+export interface IAttributes extends TransactionFactory.IAttributes<Omit<IStartParams, 'expiresInSeconds'>, IResult, IError, IPotentialActions> {
+}
+/**
+ * 返品取引
+ */
+export type ITransaction = IExtendId<IAttributes>;
+export interface ISearchConditions extends TransactionFactory.ISearchConditions<TransactionType.ReturnOrder> {
+    object?: {
+        order?: {
+            /**
+             * 返品対象注文番号
+             */
+            orderNumbers?: string[];
+        };
+        result?: {};
+    };
+}
+export {};

package/lib/transaction/returnOrder.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reason = void 0;
+/**
+ * 返品理由
+ */
+var Reason;
+(function (Reason) {
+    /**
+     * カスタマー都合での返品
+     */
+    Reason["Customer"] = "Customer";
+    /**
+     * 販売者都合での返品
+     */
+    Reason["Seller"] = "Seller";
+})(Reason = exports.Reason || (exports.Reason = {}));

package/lib/transaction.d.ts

@@ -0,0 +1,184 @@
+import * as waiter from '@waiter/factory';
+import { IExtendId } from './autoGenerated';
+import * as EmailFactory from './creativeWork/message/email';
+import { ICreativeWork as IWebApplication } from './creativeWork/softwareApplication/webApplication';
+import { IMultilingualString } from './multilingualString';
+import { OrganizationType } from './organizationType';
+import { IIdentifier, IPersonAttributes } from './person';
+import { PersonType } from './personType';
+import { SortType } from './sortType';
+import { TransactionStatusType } from './transactionStatusType';
+import { TransactionTasksExportationStatus } from './transactionTasksExportationStatus';
+import { TransactionType } from './transactionType';
+export interface IAgentAsWebApplication extends Pick<IWebApplication, 'id' | 'identifier' | 'typeOf'> {
+    name?: string;
+}
+export interface IAgentAsPerson extends Pick<IPersonAttributes, 'id' | 'identifier' | 'memberOf' | 'typeOf'> {
+    name?: string;
+}
+export type IAgent = IAgentAsWebApplication | IAgentAsPerson;
+/**
+ * 販売者
+ */
+export interface ISeller {
+    typeOf: OrganizationType.Corporation;
+    id: string;
+    name: IMultilingualString;
+}
+/**
+ * Eメール送信パラメータ
+ */
+export interface ISendEmailMessageParams {
+    /**
+     * Eメールカスタマイズ
+     * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
+     * 挿入変数として`order`を使用できます
+     * {@link https://pugjs.org/api/getting-started.html}
+     */
+    object?: EmailFactory.ICustomization;
+}
+export interface IPassportBeforeStart {
+    /**
+     * WAITER許可証発行者
+     */
+    issuer: string;
+    /**
+     * WAITER許可証トークン
+     */
+    token: waiter.passport.IEncodedPassport;
+    /**
+     * WAITER許可証トークンシークレット
+     */
+    secret: string;
+}
+export interface IProject {
+    id: string;
+    typeOf: OrganizationType.Project;
+}
+export interface ITasksExportAction {
+    agent?: {
+        name: string;
+    };
+    startDate: Date;
+    endDate?: Date;
+}
+/**
+ * 取引開始パラメータ
+ */
+export interface IStartParams<T extends TransactionType, TAgent, TRecipient, TObject> {
+    project: IProject;
+    /**
+     * 取引タイプ
+     */
+    typeOf: T;
+    /**
+     * 取引主体
+     */
+    agent: TAgent;
+    /**
+     * 取引物受取者
+     */
+    recipient?: TRecipient;
+    /**
+     * 取引対象
+     */
+    object: TObject;
+    /**
+     * 取引進行期限
+     */
+    expires: Date;
+}
+export type IAttributes<TStartParams, TResult, TError, TPotentialActions> = TStartParams & {
+    /**
+     * 取引状態
+     */
+    status: TransactionStatusType;
+    /**
+     * 取引結果
+     */
+    result?: TResult;
+    /**
+     * 取引エラー
+     */
+    error?: TError;
+    /**
+     * 取引進行期限
+     */
+    expires: Date;
+    /**
+     * 取引開始日時
+     */
+    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 TransactionType> {
+    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?: {
+        typeOf?: PersonType;
+        ids?: string[];
+        identifiers?: IIdentifier;
+        givenName?: string;
+        familyName?: string;
+        telephone?: string;
+        email?: string;
+    };
+    tasksExportationStatuses?: TransactionTasksExportationStatus[];
+}

package/lib/transaction.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,10 +1,9 @@
 /**
  * 取引ステータス
  */
-declare enum TransactionStatusType {
+export declare enum TransactionStatusType {
     InProgress = "InProgress",
     Canceled = "Canceled",
     Confirmed = "Confirmed",
     Expired = "Expired"
 }
-export default TransactionStatusType;

package/lib/{factory/transactionStatusType.js → transactionStatusType.js}

@@ -1,13 +1,13 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionStatusType = void 0;
 /**
  * 取引ステータス
  */
-Object.defineProperty(exports, "__esModule", { value: true });
 var TransactionStatusType;
 (function (TransactionStatusType) {
     TransactionStatusType["InProgress"] = "InProgress";
     TransactionStatusType["Canceled"] = "Canceled";
     TransactionStatusType["Confirmed"] = "Confirmed";
     TransactionStatusType["Expired"] = "Expired";
-})(TransactionStatusType || (TransactionStatusType = {}));
-exports.default = TransactionStatusType;
+})(TransactionStatusType = exports.TransactionStatusType || (exports.TransactionStatusType = {}));

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

@@ -1,7 +1,7 @@
 /**
  * 取引タスクエクスポートステータス
  */
-declare enum TransactionTasksExportationStatus {
+export declare enum TransactionTasksExportationStatus {
     /**
      * 未エクスポート
      */
@@ -15,4 +15,3 @@ declare enum TransactionTasksExportationStatus {
      */
     Exported = "Exported"
 }
-export default TransactionTasksExportationStatus;

package/lib/{factory/transactionTasksExportationStatus.js → transactionTasksExportationStatus.js}

@@ -1,8 +1,9 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionTasksExportationStatus = void 0;
 /**
  * 取引タスクエクスポートステータス
  */
-Object.defineProperty(exports, "__esModule", { value: true });
 var TransactionTasksExportationStatus;
 (function (TransactionTasksExportationStatus) {
     /**
@@ -17,5 +18,4 @@ var TransactionTasksExportationStatus;
      * エクスポート済
      */
     TransactionTasksExportationStatus["Exported"] = "Exported";
-})(TransactionTasksExportationStatus || (TransactionTasksExportationStatus = {}));
-exports.default = TransactionTasksExportationStatus;
+})(TransactionTasksExportationStatus = exports.TransactionTasksExportationStatus || (exports.TransactionTasksExportationStatus = {}));

package/lib/transactionType.d.ts

@@ -0,0 +1,17 @@
+/**
+ * 取引タイプ
+ */
+export declare enum TransactionType {
+    /**
+     * 通貨転送
+     */
+    MoneyTransfer = "MoneyTransfer",
+    /**
+     * 注文取引
+     */
+    PlaceOrder = "PlaceOrder",
+    /**
+     * 注文返品取引
+     */
+    ReturnOrder = "ReturnOrder"
+}

package/lib/transactionType.js

@@ -0,0 +1,21 @@
+"use strict";
+/**
+ * 取引タイプ
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransactionType = void 0;
+var TransactionType;
+(function (TransactionType) {
+    /**
+     * 通貨転送
+     */
+    TransactionType["MoneyTransfer"] = "MoneyTransfer";
+    /**
+     * 注文取引
+     */
+    TransactionType["PlaceOrder"] = "PlaceOrder";
+    /**
+     * 注文返品取引
+     */
+    TransactionType["ReturnOrder"] = "ReturnOrder";
+})(TransactionType = exports.TransactionType || (exports.TransactionType = {}));