@chevre/domain/lib/chevre/emailMessageBuilder.d.ts

Chevre Domain Library for Node.js

import * as factory from './factory';
import type { ISetting } from './repo/setting';
type ISendableEmailMessage = factory.action.transfer.send.message.email.IObjectAsEmailMessage & {
    identifier: string;
    name: string;
};
export type IOrderAsCreateEmailParams = Pick<factory.order.IOrder, 'confirmationNumber' | 'identifier' | 'customer' | 'orderDate' | 'orderNumber' | 'orderStatus' | 'orderedItem' | 'paymentMethods' | 'price' | 'priceCurrency' | 'seller' | 'typeOf'>;
/**
 * 注文配送メッセージを作成する
 */
declare function createSendOrderMessage(params: {
    order: IOrderAsCreateEmailParams;
    email?: factory.creativeWork.message.email.ICustomization;
    emailMessage?: factory.creativeWork.message.email.ICreativeWork;
    index: number;
}, setting: Pick<ISetting, 'defaultSenderEmail'>): Promise<ISendableEmailMessage>;
/**
 * 注文返品メッセージを作成する
 */
declare function createReturnOrderMessage(params: {
    order: IOrderAsCreateEmailParams;
    email?: factory.creativeWork.message.email.ICustomization;
    emailMessage?: factory.creativeWork.message.email.ICreativeWork;
    index: number;
}, setting: Pick<ISetting, 'defaultSenderEmail'>): Promise<ISendableEmailMessage>;
/**
 * 返金メッセージを作成する
 */
declare function createRefundMessage(params: {
    order: IOrderAsCreateEmailParams;
    email?: factory.creativeWork.message.email.ICustomization;
    paymentMethodId: string;
}, setting: Pick<ISetting, 'defaultSenderEmail'>): Promise<ISendableEmailMessage>;
export { createSendOrderMessage, createReturnOrderMessage, createRefundMessage };