@cinerino/sdk 16.3.0-alpha.7 → 16.3.0-alpha.9

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/chevreTxn/transaction/placeOrder/factory.d.ts

@@ -70,8 +70,16 @@ export type IEmailCustomization = Pick<factory.creativeWork.message.email.ICusto
     about?: string;
     /**
      * 本文テンプレート
-     * 本文をカスタマイズしたい場合、PUGテンプレートを指定
-     * {@link https://pugjs.org/api/getting-started.html}
+     * メール本文をカスタマイズしたい場合、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;
     /**

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

@@ -34,10 +34,7 @@ export declare class PlaceOrderTransactionService extends Service {
          */
         sendEmailMessage?: boolean;
         /**
-         * 注文配送メールカスタマイズ
-         * メール本文をカスタマイズしたい場合、PUGテンプレートを指定
-         * 挿入変数として`order`を使用できます
-         * 参考 -> https://pugjs.org/api/getting-started.html
+         * 注文配送メール指定
          */
         email?: IEmailCustomization;
         /**

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/cloud/txn/transaction/returnOrder.d.ts

@@ -1,13 +1,10 @@
-import type { IStartParams } from '../../../chevreTxn/transaction/returnOrder/factory';
+import type { IStartParams, IConfirmParams } from '../../../chevreTxn/transaction/returnOrder/factory';
 import { factory } from '../../../factory';
 import { Service } from '../../../service';
 /**
  * 返品取引サービス
  */
 export declare class ReturnOrderTransactionService extends Service {
-    /**
-     * 取引を開始する
-     */
     start(params: IStartParams): Promise<Pick<factory.transaction.ITransaction<factory.transactionType.ReturnOrder>, 'expires' | 'id' | 'project' | 'startDate' | 'status' | 'typeOf'>>;
     /**
      * 返品取引を開始可能かどうか検証する
@@ -16,5 +13,5 @@ export declare class ReturnOrderTransactionService extends Service {
     /**
      * 取引確定
      */
-    confirm(params: factory.transaction.returnOrder.IConfirmParams): Promise<void>;
+    confirm(params: IConfirmParams): Promise<void>;
 }

package/lib/abstract/cloud/txn/transaction/returnOrder.js

@@ -1,22 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReturnOrderTransactionService = void 0;
-// import { IAdditionalOptions, IOptions, Service } from '../../../service';
 const index_1 = require("../../../index");
 const service_1 = require("../../../service");
 /**
  * 返品取引サービス
  */
 class ReturnOrderTransactionService extends service_1.Service {
-    // constructor(options: Pick<
-    //     IOptions,
-    //     'auth' | 'endpoint' | 'transporter' | 'project' | 'defaultPath' | 'retryableStatusCodes'
-    // > & IAdditionalOptions) {
-    //     super(options);
-    // }
-    /**
-     * 取引を開始する
-     */
     async start(params) {
         const { agent, object } = params;
         const { auth, endpoint, project, seller, retryableStatusCodes } = this.options;
@@ -29,13 +19,6 @@ class ReturnOrderTransactionService extends service_1.Service {
             ]
         });
         return returnOrderService.start({ agent, object });
-        // return this.fetch({
-        //     uri: `/transactions/${this.typeOf}/start`,
-        //     method: 'POST',
-        //     body: params,
-        //     expectedStatusCodes: [status.OK]
-        // })
-        //     .then(async (response) => response.json());
     }
     /**
      * 返品取引を開始可能かどうか検証する
@@ -52,13 +35,6 @@ class ReturnOrderTransactionService extends service_1.Service {
             ]
         });
         await returnOrderService.verifyReturnPolicy({ object });
-        // await this.fetch({
-        //     uri: `/transactions/${this.typeOf}/start`,
-        //     method: 'POST',
-        //     body: params,
-        //     qs: { justVerify: true },
-        //     expectedStatusCodes: [NO_CONTENT, OK]
-        // });
     }
     /**
      * 取引確定
@@ -75,12 +51,6 @@ class ReturnOrderTransactionService extends service_1.Service {
             ]
         });
         await returnOrderService.confirm({ id, potentialActions });
-        // await this.fetch({
-        //     uri: `/transactions/${this.typeOf}/${params.id}/confirm`,
-        //     method: 'PUT',
-        //     body: params,
-        //     expectedStatusCodes: [status.NO_CONTENT]
-        // });
     }
 }
 exports.ReturnOrderTransactionService = ReturnOrderTransactionService;