@cinerino/sdk 16.3.0-alpha.1 → 16.3.0-alpha.11

package/lib/abstract/chevreAdmin/order.d.ts

@@ -1,4 +1,4 @@
-import { IOrderAsSearchResult, IOrderAsFindAcceptedOffersResult, IReturner, IFindParams, IFindAcceptedOffersParams, IProjection, IUpdateChangeableAttributesParams } from '../chevreConsole/order/factory';
+import { IOrderAsSearchResult, IOrderAsFindAcceptedOffersResult, IReturner, IFindParams, IFindAcceptedOffersParams, IUpdateChangeableAttributesParams } from '../chevreConsole/order/factory';
 import { factory } from '../factory';
 import { Service } from '../service';
 /**
@@ -17,18 +17,6 @@ export declare class OrderService extends Service {
      * 注文オファーを検索する
      */
     findOrderAcceptedOffers(params: IFindAcceptedOffersParams): Promise<IOrderAsFindAcceptedOffersResult[]>;
-    /**
-     * 注文取得
-     */
-    findByOrderNumber(params: {
-        /**
-         * 注文番号
-         */
-        orderNumber: string;
-    }, options: {
-        $projection?: IProjection;
-        $projectDisabled?: '1';
-    }): Promise<Pick<factory.order.IOrder, 'broker' | 'confirmationNumber' | 'customer' | 'dateReturned' | 'id' | 'identifier' | 'name' | 'orderDate' | 'orderNumber' | 'orderStatus' | 'orderedItem' | 'paymentMethods' | 'previousOrderStatus' | 'price' | 'priceCurrency' | 'project' | 'seller' | 'typeOf' | 'url'>>;
     /**
      * 返品者検索
      */

package/lib/abstract/chevreAdmin/order.js

@@ -46,18 +46,6 @@ class OrderService extends service_1.Service {
         })
             .then(async (response) => response.json());
     }
-    /**
-     * 注文取得
-     */
-    async findByOrderNumber(params, options) {
-        return this.fetch({
-            uri: `/orders/${params.orderNumber}`,
-            method: 'GET',
-            expectedStatusCodes: [http_status_1.status.OK],
-            qs: options
-        })
-            .then(async (response) => response.json());
-    }
     /**
      * 返品者検索
      */

package/lib/abstract/chevreAdmin/reservation.d.ts

@@ -1,5 +1,5 @@
 import { factory } from '../factory';
-import { ITicket, IUseAction } from '../chevreConsole/reservation/factory';
+import { ITicket, IUseAction, IReservationAsFindResult } from '../chevreConsole/reservation/factory';
 import { Service } from '../service';
 export interface IUseActionResult {
     id: string;
@@ -64,7 +64,7 @@ export declare class ReservationService extends Service {
          * min: 1
          */
         page: number;
-    }): Promise<factory.reservation.eventReservation.IReservation[]>;
+    }): Promise<IReservationAsFindResult[]>;
     /**
      * 予約を使用する(入場する)
      */

package/lib/abstract/chevreAsset/order.js

@@ -38,9 +38,7 @@ class OrderService extends service_1.Service {
     /**
      * イベントIDと確認番号で検索
      */
-    async findByEventAndConfirmationNumber(params
-    // & IProjectionSearchConditions // discontinue(2024-07-24~)
-    ) {
+    async findByEventAndConfirmationNumber(params) {
         return this.fetch({
             uri: '/orders/findByEventAndConfirmationNumber',
             method: 'POST',

package/lib/abstract/chevreConsole/assetTransaction/pay.d.ts

@@ -15,15 +15,6 @@ export declare class PayAssetTransactionService extends Service {
     check(params: factory.action.check.paymentMethod.movieTicket.IAttributes): Promise<{
         result: ICheckMovieTicketResult;
     }>;
-    /**
-     * 決済ロケーション無効化
-     */
-    /**
-     * 決済ロケーション発行
-     */
-    /**
-     * 取引開始
-     */
     /**
      * 取引確定
      */

package/lib/abstract/chevreConsole/assetTransaction/pay.js

@@ -20,47 +20,6 @@ class PayAssetTransactionService extends service_1.Service {
         })
             .then(async (response) => response.json());
     }
-    /**
-     * 決済ロケーション無効化
-     */
-    // public async invalidatePaymentUrl(
-    //     params: factory.task.refund.IData
-    // ): Promise<void> {
-    //     await this.fetch({
-    //         uri: `/assetTransactions/${factory.assetTransactionType.Pay}/invalidatePaymentUrl`,
-    //         method: 'PUT',
-    //         body: params,
-    //         expectedStatusCodes: [status.NO_CONTENT]
-    //     });
-    // }
-    /**
-     * 決済ロケーション発行
-     */
-    // public async publishPaymentUrl(
-    //     params: factory.assetTransaction.pay.IStartParamsWithoutDetail
-    // ): Promise<IPublishPaymentUrlResult> {
-    //     return this.fetch({
-    //         uri: `/assetTransactions/${factory.assetTransactionType.Pay}/publishPaymentUrl`,
-    //         method: 'POST',
-    //         body: params,
-    //         expectedStatusCodes: [status.OK]
-    //     })
-    //         .then(async (response) => response.json());
-    // }
-    /**
-     * 取引開始
-     */
-    // public async start(
-    //     params: factory.assetTransaction.pay.IStartParamsWithoutDetail
-    // ): Promise<{ id: string }> {
-    //     return this.fetch({
-    //         uri: `/assetTransactions/${factory.assetTransactionType.Pay}/start`,
-    //         method: 'POST',
-    //         body: params,
-    //         expectedStatusCodes: [status.OK]
-    //     })
-    //         .then(async (response) => response.json());
-    // }
     /**
      * 取引確定
      */

package/lib/abstract/chevreConsole/emailMessage.d.ts

@@ -1,15 +1,20 @@
 import { factory } from '../factory';
-import { ISearchResult, IUnset, Service } from '../service';
-export type IEmailMessage = Omit<factory.creativeWork.message.email.ICreativeWork, 'toRecipient'>;
+import { IUnset, Service } from '../service';
+export type IEmailMessage = Pick<factory.creativeWork.message.email.ICreativeWork, 'about' | 'identifier' | 'name' | 'project' | 'sender' | 'text' | 'typeOf'> & {
+    id: string;
+};
 export interface ISearchConditions {
     limit?: number;
     page?: number;
+    id?: {
+        $eq?: string;
+    };
     identifier?: {
         $eq?: string;
     };
     about?: {
         identifier?: {
-            $eq?: factory.creativeWork.message.email.AboutIdentifier;
+            $eq?: factory.creativeWork.message.email.AboutIdentifier.OnEventStatusChanged;
         };
     };
 }
@@ -20,25 +25,19 @@ export declare class EmailMessageService extends Service {
     /**
      * 作成
      */
-    create(params: IEmailMessage): Promise<{
+    create(params: Omit<IEmailMessage, 'id' | 'project'>): Promise<{
         id: string;
     }>;
-    /**
-     * 取得
-     */
-    findById(params: {
-        id: string;
-    }): Promise<IEmailMessage>;
     /**
      * 検索
      */
-    search(params: ISearchConditions): Promise<ISearchResult<IEmailMessage[]>>;
+    findEmailMessages(params: ISearchConditions): Promise<IEmailMessage[]>;
     /**
      * 編集
      */
     update(params: {
         id: string;
-        attributes: IEmailMessage & IUnset;
+        attributes: Omit<IEmailMessage, 'id' | 'project'> & IUnset;
     }): Promise<void>;
     /**
      * 削除

package/lib/abstract/chevreConsole/emailMessage.js

@@ -19,33 +19,17 @@ class EmailMessageService extends service_1.Service {
         })
             .then(async (response) => response.json());
     }
-    /**
-     * 取得
-     */
-    async findById(params) {
-        return this.fetch({
-            uri: `/emailMessages/${params.id}`,
-            method: 'GET',
-            // qs: params,
-            expectedStatusCodes: [http_status_1.status.OK]
-        })
-            .then(async (response) => response.json());
-    }
     /**
      * 検索
      */
-    async search(params) {
+    async findEmailMessages(params) {
         return this.fetch({
             uri: '/emailMessages',
             method: 'GET',
             qs: params,
             expectedStatusCodes: [http_status_1.status.OK]
         })
-            .then(async (response) => {
-            return {
-                data: await response.json()
-            };
-        });
+            .then(async (response) => response.json());
     }
     /**
      * 編集

package/lib/abstract/chevreConsole/order.js

@@ -41,22 +41,6 @@ class OrderService extends service_1.Service {
             expectedStatusCodes: [http_status_1.status.NO_CONTENT]
         });
     }
-    // /**
-    //  * 返品
-    //  */
-    // public async returnOrder(params: {
-    //     orderNumber: string;
-    //     dateReturned: Date;
-    //     returner: factory.order.IReturner;
-    // }): Promise<void> {
-    //     const { dateReturned, orderNumber, returner } = params;
-    //     await this.fetch({
-    //         uri: `/orders/${orderNumber}/${factory.orderStatus.OrderReturned}`,
-    //         method: 'PUT',
-    //         body: { dateReturned, returner },
-    //         expectedStatusCodes: [status.NO_CONTENT]
-    //     });
-    // }
     /**
      * 注文に対するアクションを検索する
      */

package/lib/abstract/chevreConsole/reservation/factory.d.ts

@@ -18,4 +18,8 @@ interface ITicketAsCode {
  * 予約使用チケット
  */
 export type ITicket = ITicketAsCode;
+/**
+ * 予約検索結果としての予約
+ */
+export type IReservationAsFindResult = Pick<factory.reservation.eventReservation.IReservation, 'additionalTicketText' | 'attended' | 'bookingTime' | 'checkedIn' | 'id' | 'reservationFor' | 'reservationNumber' | 'reservationStatus' | 'reservedTicket'>;
 export {};

package/lib/abstract/chevreConsole/reservation/factory.js

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// export type ITicket = ITicketAsJWT | ITicketAsCode;

package/lib/abstract/chevreTxn/transaction/placeOrder/factory.d.ts

@@ -12,13 +12,12 @@ export interface IStartParams {
          */
         customer?: {
             /**
-             * factory.personType.Personを指定すれば会員注文として
              * factory.organizationType.Organizationを指定すれば顧客注文として
              * 処理されます
              */
-            typeOf: factory.personType.Person | factory.organizationType.Organization;
+            typeOf: factory.organizationType.Organization;
             /**
-             * 会員ID or 顧客ID
+             * 顧客ID
              */
             id?: string;
         };
@@ -51,14 +50,9 @@ export interface IMinimalAuthorizeEventServiceResult {
 }
 export interface IOptionalConfirmResult {
     code?: string;
-    eventId?: string;
     reservationIds?: string[];
 }
-export type IOrderAsConfirmResult = Pick<factory.order.IOrder, 'confirmationNumber' | 'orderNumber'> & {
-    customer: {
-        telephone: string;
-    };
-};
+export type IOrderAsConfirmResult = Pick<factory.order.IOrder, 'confirmationNumber' | 'orderNumber'> & {};
 export type IConfirmResult4tttsPOS = {
     order: IOrderAsConfirmResult;
 } & IOptionalConfirmResult;
@@ -66,6 +60,37 @@ export type IMinimalOrderAsConfirmResult = Pick<factory.order.IOrder, 'confirmat
 export interface IMinimalConfirmResult {
     order: IMinimalOrderAsConfirmResult;
 }
+/**
+ * 注文取引確定時のEメール指定
+ */
+export type IEmailCustomization = Pick<factory.creativeWork.message.email.ICustomization, 'text'> & {
+    /**
+     * 件名
+     */
+    about?: string;
+    /**
+     * 本文テンプレート
+     * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
+     * 挿入変数として以下を使用できます
+     * - order.customer.familyName
+     * - order.customer.givenName
+     * - order.confirmationNumber
+     * - order.orderNumber
+     * - order.price
+     * - order.seller.name
+     *
+     * 参考 -> https://pugjs.org/api/getting-started.html
+     */
+    template?: string;
+    /**
+     * 受信者
+     */
+    toRecipient?: factory.creativeWork.message.email.ICustomizedParticipant;
+    /**
+     * 送信者
+     */
+    sender?: Pick<factory.creativeWork.message.email.ICustomizedParticipant, 'name'>;
+};
 /**
  * 興行オファーチケット
  */

package/lib/abstract/chevreTxn/transaction/placeOrder.d.ts

@@ -1,7 +1,7 @@
 import { factory } from '../../factory';
 import { Service } from '../../service';
 import { ISetProfileParams } from '../transaction';
-import { IConfirmResult4tttsPOS, IMinimalConfirmResult, IStartParams, IStartPlaceOrderResult } from './placeOrder/factory';
+import { IEmailCustomization, IConfirmResult4tttsPOS, IMinimalConfirmResult, IStartParams, IStartPlaceOrderResult } from './placeOrder/factory';
 /**
  * 注文取引サービス
  */
@@ -15,12 +15,6 @@ export declare class PlaceOrderTransactionService extends Service {
      * 取引人プロフィール変更
      */
     setProfile(params: ISetProfileParams): Promise<void>;
-    updateObject(params: {
-        id: string;
-        object: {
-            name?: string;
-        };
-    }): Promise<void>;
     /**
      * 取引期限変更
      */
@@ -40,16 +34,9 @@ export declare class PlaceOrderTransactionService extends Service {
          */
         sendEmailMessage?: boolean;
         /**
-         * 注文配送メールカスタマイズ
-         * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
-         * 挿入変数として`order`を使用できます
-         * 参考 -> https://pugjs.org/api/getting-started.html
-         */
-        email?: factory.creativeWork.message.email.ICustomization;
-        /**
-         * レスポンスを最小化する
+         * 注文配送メール指定
          */
-        expectsMinimalResponse?: boolean;
+        email?: IEmailCustomization;
         /**
          * @deprecated
          */

package/lib/abstract/chevreTxn/transaction/placeOrder.js

@@ -32,14 +32,18 @@ class PlaceOrderTransactionService extends service_1.Service {
             body: params.agent
         });
     }
-    async updateObject(params) {
-        await this.fetch({
-            uri: `/transactions/${this.typeOf}/${params.id}/object`,
-            method: 'PATCH',
-            expectedStatusCodes: [http_status_1.status.NO_CONTENT],
-            body: params.object
-        });
-    }
+    // 進行中取引の名称変更は廃止(2026-06-11~)
+    // public async updateObject(params: {
+    //     id: string;
+    //     object: { name?: string };
+    // }): Promise<void> {
+    //     await this.fetch({
+    //         uri: `/transactions/${this.typeOf}/${params.id}/object`,
+    //         method: 'PATCH',
+    //         expectedStatusCodes: [status.NO_CONTENT],
+    //         body: params.object
+    //     });
+    // }
     /**
      * 取引期限変更
      */

package/lib/abstract/chevreTxn/transaction/returnOrder/factory.d.ts

@@ -14,3 +14,89 @@ export interface IStartParams {
         reason?: factory.transaction.returnOrder.Reason;
     };
 }
+/**
+ * 返品取引確定時のEメール指定
+ */
+export type IEmailCustomization = Pick<factory.creativeWork.message.email.ICustomization, 'text'> & {
+    /**
+     * 件名
+     */
+    about?: string;
+    /**
+     * 本文テンプレート
+     * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
+     * 挿入変数として以下を使用できます
+     * - order.customer.familyName
+     * - order.customer.givenName
+     * - order.confirmationNumber
+     * - order.orderNumber
+     * - order.price
+     * - order.seller.name
+     *
+     * 参考 -> https://pugjs.org/api/getting-started.html
+     */
+    template?: string;
+    /**
+     * 受信者
+     */
+    toRecipient?: factory.creativeWork.message.email.ICustomizedParticipant;
+    /**
+     * 送信者
+     */
+    sender?: Pick<factory.creativeWork.message.email.ICustomizedParticipant, 'name'>;
+};
+/**
+ * Eメール送信パラメータ
+ */
+export interface ISendEmailMessageParams {
+    /**
+     * Eメールカスタマイズ
+     * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
+     * 挿入変数として`order`を使用できます
+     * {@link https://pugjs.org/api/getting-started.html}
+     */
+    object?: IEmailCustomization;
+}
+export interface IRefundParams {
+    object: {
+        object: {
+            paymentMethod: {
+                /**
+                 * 返金対象決済方法ID
+                 */
+                paymentMethodId: string;
+            };
+        }[];
+    };
+    potentialActions?: {
+        /**
+         * 返金メールカスタマイズ
+         */
+        sendEmailMessage?: ISendEmailMessageParams;
+    };
+}
+export interface IPotentialActionsParams {
+    /**
+     * 注文返品アクション
+     */
+    returnOrder?: {
+        /**
+         * 注文返品後アクション
+         */
+        potentialActions?: {
+            /**
+             * 返金アクションについてカスタマイズする場合に指定
+             * 属性名称がrefundCreditCardであるが、全ての決済方法に適用可能
+             */
+            refundCreditCard?: IRefundParams[];
+            /**
+             * 返品時Eメール送信アクション
+             * 最大1つ指定
+             */
+            sendEmailMessage?: [ISendEmailMessageParams];
+        };
+    };
+}
+export type IConfirmParams = Pick<factory.transaction.returnOrder.IConfirmParams, 'id'> & {
+    potentialActions?: IPotentialActionsParams;
+};

package/lib/abstract/chevreTxn/transaction/returnOrder/factory.js

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

package/lib/abstract/chevreTxn/transaction/returnOrder.d.ts

@@ -1,7 +1,7 @@
 import { factory } from '../../factory';
 import { Service } from '../../service';
 import { ISetProfileParams } from '../transaction';
-import { IStartParams } from '../transaction/returnOrder/factory';
+import { IStartParams, IConfirmParams } from '../transaction/returnOrder/factory';
 /**
  * 返品取引サービス
  */
@@ -22,5 +22,5 @@ export declare class ReturnOrderTransactionService extends Service {
     /**
      * 取引確定
      */
-    confirm(params: factory.transaction.returnOrder.IConfirmParams): Promise<void>;
+    confirm(params: IConfirmParams): Promise<void>;
 }

package/lib/abstract/cinerino/service/emailMessage.d.ts

@@ -1,18 +1,6 @@
 import { factory } from '../../factory';
 import { IAdditionalOptions, IOptions, ISearchResult, Service } from '../../service';
-export type IEmailMessage = factory.creativeWork.message.email.ICreativeWork;
-export interface ISearchConditions {
-    limit?: number;
-    page?: number;
-    identifier?: {
-        $eq?: string;
-    };
-    about?: {
-        identifier?: {
-            $eq?: factory.creativeWork.message.email.AboutIdentifier;
-        };
-    };
-}
+export type IEmailMessage = Pick<factory.creativeWork.message.email.ICreativeWork, 'about' | 'id' | 'sender' | 'text'>;
 /**
  * Eメールメッセージサービス
  */
@@ -21,5 +9,5 @@ export declare class EmailMessageService extends Service {
     /**
      * 検索
      */
-    search(params: ISearchConditions): Promise<ISearchResult<IEmailMessage[]>>;
+    search(): Promise<ISearchResult<IEmailMessage[]>>;
 }

package/lib/abstract/cinerino/service/emailMessage.js

@@ -13,11 +13,11 @@ class EmailMessageService extends service_1.Service {
     /**
      * 検索
      */
-    async search(params) {
+    async search() {
         return this.fetch({
             uri: '/emailMessages',
             method: 'GET',
-            qs: params,
+            // qs: params,
             expectedStatusCodes: [http_status_1.status.OK]
         })
             .then(async (response) => {

package/lib/abstract/cloud/admin/order.d.ts

@@ -1,21 +1,11 @@
 import { factory } from '../../factory';
 import { Service } from '../../service';
-import { IOrderAsFindByConfirmationNumberResult } from '../../chevreAsset/order/factory';
 import { IFindParams, IFindAcceptedOffersParams, IOrderAsSearchResult, IOrderAsFindAcceptedOffersResult, IReturner, IUpdateChangeableAttributesParams } from '../../chevreConsole/order/factory';
 type IFindOrderParams = Pick<IFindParams, 'acceptedOffers' | 'confirmationNumbers' | 'customer' | 'name' | 'orderDate' | 'orderNumbers' | 'orderStatuses' | 'paymentMethods' | 'limit' | 'page' | 'sort'>;
 /**
  * 注文管理サービス
  */
 export declare class OrderService extends Service {
-    /**
-     * 注文取得
-     */
-    findByOrderNumber(params: {
-        /**
-         * 注文番号
-         */
-        orderNumber: string;
-    }): Promise<IOrderAsFindByConfirmationNumberResult>;
     /**
      * 管理者による注文検索
      */

package/lib/abstract/cloud/admin/order.js

@@ -9,20 +9,6 @@ const MAX_SEARCH_LIMIT = 20;
  * 注文管理サービス
  */
 class OrderService extends service_1.Service {
-    /**
-     * 注文取得
-     */
-    async findByOrderNumber(params) {
-        const { auth, endpoint, project, seller } = this.options;
-        const chevreAdmin = await (0, index_1.loadChevreAdmin)({ auth, endpoint });
-        const orderService = await chevreAdmin.createOrderInstance({
-            project,
-            seller: { id: (typeof seller?.id === 'string') ? seller.id : '' }
-        });
-        return orderService.findByOrderNumber({ orderNumber: String(params.orderNumber) }, {
-        // $projection: DEFAULT_PROJECTION
-        });
-    }
     /**
      * 管理者による注文検索
      */

package/lib/abstract/cloud/admin/reservation.d.ts

@@ -1,4 +1,4 @@
-import { ITicket, IUseAction } from '../../chevreConsole/reservation/factory';
+import { ITicket, IUseAction, IReservationAsFindResult } from '../../chevreConsole/reservation/factory';
 import { factory } from '../../factory';
 import { Service } from '../../service';
 /**
@@ -35,10 +35,6 @@ type IFindParams = Pick<factory.reservation.eventReservation.ISearchConditions,
         };
     };
 };
-/**
- * 予約検索結果としての予約
- */
-type IReservationAsFindResult = Pick<factory.reservation.eventReservation.IReservation, 'additionalTicketText' | 'attended' | 'bookingTime' | 'checkedIn' | 'id' | 'reservationFor' | 'reservationNumber' | 'reservationStatus' | 'reservedTicket'>;
 /**
  * 予約サービス
  */

package/lib/abstract/cloud/asset/order.d.ts

@@ -43,7 +43,7 @@ export declare class OrderService extends Service {
         orderNumber?: string;
     }): Promise<IOrderAsFindByConfirmationNumberResult[]>;
     /**
-     * イベントIDと確認番号で検索
+     * [ttts専用]イベントIDと確認番号で検索
      */
     findByEventAndConfirmationNumber(params: {
         /**
@@ -53,8 +53,11 @@ export declare class OrderService extends Service {
         /**
          * 購入者情報
          */
-        customer?: {
-            telephone?: string;
+        customer: {
+            /**
+             * 下4桁
+             */
+            telephone: string;
         };
         event: {
             id: {

package/lib/abstract/cloud/asset/order.js

@@ -55,7 +55,7 @@ class OrderService extends service_1.Service {
         });
     }
     /**
-     * イベントIDと確認番号で検索
+     * [ttts専用]イベントIDと確認番号で検索
      */
     async findByEventAndConfirmationNumber(params) {
         const { auth, endpoint, project, seller, disableAutoRetry, retryableStatusCodes } = this.options;
@@ -70,7 +70,6 @@ class OrderService extends service_1.Service {
         });
         return orderService.findByEventAndConfirmationNumber({
             confirmationNumber, event,
-            // $projection: DEFAULT_PROJECTION, // fixed on server side(2024-07-22~)
             ...(typeof customer?.telephone === 'string') ? { customer } : undefined
         });
     }