@trusted-solutions/sdit.models 0.24.4 → 0.25.1

package/lambda/online-integration.d.ts

@@ -1,110 +1,110 @@
-import { Order, Receipt, Operator, MenuPath } from '../models';
-import { OMMConfig, OOReasonCode, OnlinePlatformType, OMMItemContextType, OMMItemContentEntityType, SOPSContent, StoreOnlinePlatformStore, ThirdPartyStoreIntegrationType } from '../models/online-integration';
-import { SingleItem } from './response';
-/**
- * 若Order為已付款時，可在accept時帶入invoiceConfig, invoice
- * 反之，則不需帶入
- */
-export interface AcceptOnlineOrderRequest {
-    storeId: string;
-    orderId: string;
-    posSerialNumber: string;
-    addReceipt?: Receipt;
-}
-export interface AcceptOnlineOrderResponse {
-    storeId: string;
-    orderId: string;
-    partialUpdateOrder: Partial<Order>;
-    receipt?: Receipt;
-}
-export interface RejectOnlineOrderRequest {
-    storeId: string;
-    orderId: string;
-    operator: Operator;
-    reasonCode: OOReasonCode;
-    reason?: string;
-}
-export interface RejectOnlineOrderResponse {
-    storeId: string;
-    orderId: string;
-    partialUpdateOrder: Partial<Order>;
-}
-export interface CancelOnlineOrderRequest {
-    storeId: string;
-    orderId: string;
-    operator: Operator;
-    reasonCode: OOReasonCode;
-    reason?: string;
-}
-export interface CancelOnlineOrderResponse {
-    storeId: string;
-    orderId: string;
-    partialUpdateOrder: Partial<Order>;
-    voidedReceipt?: Receipt;
-}
-export interface CompleteOnlineOrderRequest {
-    storeId: string;
-    orderId: string;
-}
-export interface CompleteOnlineOrderResponse {
-    storeId: string;
-    orderId: string;
-    partialUpdateOrder: Partial<Order>;
-}
-export interface GetOMMConfigRequest {
-    storeId: string;
-    onlinePlatformType: OnlinePlatformType;
-}
-export interface GetOMMConfigResponse {
-    item: OMMConfig;
-}
-export interface UpsertOMMItemsRequest {
-    storeId: string;
-    requests: OMMItemRequest[];
-}
-export declare type UpsertOMMItemsResponse = null;
-export interface OMMItemRequest {
-    onlineItemId: string;
-    overrideId?: {
-        contextType: OMMItemContextType;
-        contextValue: string;
-    };
-    content: {
-        entityName: OMMItemContentEntityType;
-        entityId: string;
-    };
-}
-/** ========  OnlinePlatformStore ============= */
-interface BaseSOPSRequest {
-    storeId: string;
-    onlinePlatformType?: ThirdPartyStoreIntegrationType;
-    onlinePlatformStoreId: string;
-}
-export interface BindOPSIdRequest extends StoreOnlinePlatformStore {
-}
-export declare type BindOPSIdResponse = null;
-export interface UnbindOPSIdRequest extends BaseSOPSRequest {
-}
-export declare type UnbindOPSIdResponse = null;
-export interface GetOPSByStoreIdRequest {
-    storeId: string;
-    onlinePlatformType: ThirdPartyStoreIntegrationType;
-}
-export interface GetStoreIdByOPSIdRequest {
-    onlinePlatformStoreId: string;
-    onlinePlatformType: ThirdPartyStoreIntegrationType;
-}
-export declare type GetOPSByStoreIdResponse = StoreOnlinePlatformStore;
-export declare type GetStoreIdByOPSIdResponse = SingleItem<string>;
-export interface UpdateSOPSContentRequest extends BaseSOPSRequest, SOPSContent {
-}
-export declare type UpdateSOPSContentResponse = null;
-/**
- * submit third party menu data
- */
-export interface SubmitThirdPartyMenuDataRequest {
-    storeId: string;
-    menuPath: MenuPath;
-}
-export declare type SubmitThirdPartyMenuDataResponse = {};
-export {};
+import { Order, Receipt, Operator, MenuPath } from '../models';
+import { OMMConfig, OOReasonCode, OnlinePlatformType, OMMItemContextType, OMMItemContentEntityType, SOPSContent, StoreOnlinePlatformStore, ThirdPartyStoreIntegrationType } from '../models/online-integration';
+import { SingleItem } from './response';
+/**
+ * 若Order為已付款時，可在accept時帶入invoiceConfig, invoice
+ * 反之，則不需帶入
+ */
+export interface AcceptOnlineOrderRequest {
+    storeId: string;
+    orderId: string;
+    posSerialNumber: string;
+    addReceipt?: Receipt;
+}
+export interface AcceptOnlineOrderResponse {
+    storeId: string;
+    orderId: string;
+    partialUpdateOrder: Partial<Order>;
+    receipt?: Receipt;
+}
+export interface RejectOnlineOrderRequest {
+    storeId: string;
+    orderId: string;
+    operator: Operator;
+    reasonCode: OOReasonCode;
+    reason?: string;
+}
+export interface RejectOnlineOrderResponse {
+    storeId: string;
+    orderId: string;
+    partialUpdateOrder: Partial<Order>;
+}
+export interface CancelOnlineOrderRequest {
+    storeId: string;
+    orderId: string;
+    operator: Operator;
+    reasonCode: OOReasonCode;
+    reason?: string;
+}
+export interface CancelOnlineOrderResponse {
+    storeId: string;
+    orderId: string;
+    partialUpdateOrder: Partial<Order>;
+    voidedReceipt?: Receipt;
+}
+export interface CompleteOnlineOrderRequest {
+    storeId: string;
+    orderId: string;
+}
+export interface CompleteOnlineOrderResponse {
+    storeId: string;
+    orderId: string;
+    partialUpdateOrder: Partial<Order>;
+}
+export interface GetOMMConfigRequest {
+    storeId: string;
+    onlinePlatformType: OnlinePlatformType;
+}
+export interface GetOMMConfigResponse {
+    item: OMMConfig;
+}
+export interface UpsertOMMItemsRequest {
+    storeId: string;
+    requests: OMMItemRequest[];
+}
+export declare type UpsertOMMItemsResponse = null;
+export interface OMMItemRequest {
+    onlineItemId: string;
+    overrideId?: {
+        contextType: OMMItemContextType;
+        contextValue: string;
+    };
+    content: {
+        entityName: OMMItemContentEntityType;
+        entityId: string;
+    };
+}
+/** ========  OnlinePlatformStore ============= */
+interface BaseSOPSRequest {
+    storeId: string;
+    onlinePlatformType?: ThirdPartyStoreIntegrationType;
+    onlinePlatformStoreId: string;
+}
+export interface BindOPSIdRequest extends StoreOnlinePlatformStore {
+}
+export declare type BindOPSIdResponse = null;
+export interface UnbindOPSIdRequest extends BaseSOPSRequest {
+}
+export declare type UnbindOPSIdResponse = null;
+export interface GetOPSByStoreIdRequest {
+    storeId: string;
+    onlinePlatformType: ThirdPartyStoreIntegrationType;
+}
+export interface GetStoreIdByOPSIdRequest {
+    onlinePlatformStoreId: string;
+    onlinePlatformType: ThirdPartyStoreIntegrationType;
+}
+export declare type GetOPSByStoreIdResponse = StoreOnlinePlatformStore;
+export declare type GetStoreIdByOPSIdResponse = SingleItem<string>;
+export interface UpdateSOPSContentRequest extends BaseSOPSRequest, SOPSContent {
+}
+export declare type UpdateSOPSContentResponse = null;
+/**
+ * submit third party menu data
+ */
+export interface SubmitThirdPartyMenuDataRequest {
+    storeId: string;
+    menuPath: MenuPath;
+}
+export declare type SubmitThirdPartyMenuDataResponse = {};
+export {};

package/lambda/online-integration.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=online-integration.js.map

package/lambda/online-ordering.d.ts

@@ -1,230 +1,230 @@
-import { Address, DayOfWeekTimePeriod, GalleryConfig, Operator } from '../models/store';
-import { MultiLanguageText, OrderDiscount } from '../models';
-import { ServeType } from '../enums';
-import { SOPublicMenu, SOPublicCategory, SOPublicProduct, SOPublicProductAttribute, SOPublicProductAttributeCategory, SOPaymentMethod, SOValidateCart, SOOrderState, SOOrder, SOEater } from '../models/online-ordering';
-/**
- * SO = SDIT Online
- */
-/*******************************/
-/**  SOGetStoreInfo */
-/*******************************/
-export interface SOGetStoreInfoRequest {
-    storeId: string;
-}
-export interface SOGetStoreInfoResponse {
-    storeId: string;
-    /**
-     * 線上店名
-     * @Default 店內名稱
-     */
-    storeName: string;
-    /**
-     * 聯絡電話
-     */
-    phone?: string;
-    /**
-     * 店址
-     */
-    address?: Address;
-    /**
-     * 線上店營業時間
-     *  @Default []
-     */
-    openingHours: DayOfWeekTimePeriod[];
-    /**
-     * 橫幅
-     */
-    bannerConfig: GalleryConfig;
-    /**
-     * 點餐公告
-     * @Default {zh-TW: ''}
-     */
-    orderAnnouncement: MultiLanguageText;
-    /**
-     * 結帳公告
-     * @Default {zh-TW: ''}
-     */
-    checkoutAnnouncement: MultiLanguageText;
-    /**
-     * 關閉訂單備註輸入
-     * @Default false
-     */
-    orderNoteHidden: boolean;
-    /**
-     * 關閉訂單品項備註輸入
-     * @Default false
-     */
-    orderItemNoteHidden: boolean;
-    /**
-     * 關閉統編輸入
-     * 若沒啟用統一發票強制 false
-     * @Default false
-     */
-    buyerIdInputHidden: boolean;
-    /**
-     * 線上店到untilOpen之後可接單
-     * 設Infinity為永久停業
-     * @Default null
-     */
-    untilOpen: number;
-    /**
-     * 是否使用線上點餐
-     * @Default false
-     */
-    enabled: boolean;
-    /**
-     * 線上點餐支付方式
-     * @Default [現場付款]
-     */
-    paymentMethods: SOPaymentMethod[];
-    /**
-     * 線上點餐預計等待時間(分)
-     * @Default 30
-     */
-    onlineEstimatedReadyForPickupTime: number;
-}
-/*******************************/
-/*******************************/
-export interface SOGetStoreMenuRequest {
-    storeId: string;
-    /**
-     *  undefined: 現在
-     */
-    when?: number;
-}
-export interface SOGetStoreMenuResponse {
-    menus: SOPublicMenu[];
-    categories: SOPublicCategory[];
-    products: SOPublicProduct[];
-    /**
-     * 只顯示可見的註記
-     */
-    attributes: SOPublicProductAttribute[];
-    /**
-     * 只顯示可見的註記類別
-     */
-    attributeCategories: SOPublicProductAttributeCategory[];
-}
-/*******************************/
-/*******************************/
-export interface SOValidateMutationRequest {
-    storeId: string;
-    traceId: string;
-    /**
-     * 預計取餐時間 timestamp ms
-     * 不給值 = 盡快
-     */
-    expectedPickupAt?: number;
-    cart: SOValidateCart;
-}
-/**
- * @throw `SOOrderError`
- */
-export interface SOValidateMutationResponse {
-    storeId: string;
-    traceId: string;
-    /**
-     * 小計
-     */
-    subtotal: number;
-    /**
-     * 折扣
-     */
-    discount: OrderDiscount;
-    /**
-     * 總折扣金額
-     */
-    totalDiscountAmount: number;
-    /**
-     * 結帳金額
-     */
-    totalAmount: number;
-}
-/*******************************/
-/*******************************/
-export interface SOSendOrderRequest {
-    storeId: string;
-    serveType: ServeType;
-    eater: SOEater;
-    cart: SOValidateCart;
-    /**
-     * 是否為現場付款
-     * 選擇現場付款的訂單，會馬上成立無法再改付款方式。
-     */
-    isOnSitePayment: boolean;
-    /**
-     *  包裝、免洗餐具
-     */
-    includeDisposableItems: boolean;
-    /**
-     * 預計取餐時間 timestamp ms
-     * 不給值 = 盡快
-     */
-    expectedPickupAt?: number;
-}
-/**
- * @throw `SOOrderError`
- */
-export interface SOSendOrderResponse {
-    /** online Order Id */
-    id: string;
-    state: SOOrderState;
-    /** 消費者識別用 id的末五碼 == Order.serialNumber */
-    displayId: string;
-    isOnSitePayment: boolean;
-}
-/*******************************/
-/*******************************/
-export interface SOGetPaymentUrlRequest {
-    storeId: string;
-    /** online Order Id */
-    id: string;
-    /**
-     * 以MyPay為例
-     * 可在產生付款網址時，決定returnUrl
-     * 若不填寫，則以MyPay特約店家後台設定的為主
-     */
-    successReturnUrl?: string;
-    /**
-     * 以MyPay為例
-     * 可在產生付款網址時，決定returnUrl
-     * 若不填寫，則以MyPay特約店家後台設定的為主
-     */
-    failureReturnUrl?: string;
-}
-export interface SOGetPaymentUrlResponse {
-    payUrl: string;
-}
-/*******************************/
-/*******************************/
-export interface SOCancelOrderRequest {
-    storeId: string;
-    /** online order id */
-    id: string;
-}
-export interface SOCancelOrderResponse {
-    storeId: string;
-    /** online order id */
-    id: string;
-    state: SOOrderState;
-}
-/*******************************/
-/*******************************/
-export interface SOGetOrderRequest {
-    storeId: string;
-    /** online order id */
-    id: string;
-}
-export interface SOGetOrderResponse {
-    storeId: string;
-    order: SOOrder;
-}
-/*******************************/
-/*******************************/
-export interface SOChangeStoreStatusRequest {
-    storeId: string;
-    operator?: Operator;
-    isOpen: boolean;
-    enabled: boolean;
-}
-export declare type SOChangeStoreStatusResponse = null;
+import { Address, DayOfWeekTimePeriod, GalleryConfig, Operator } from '../models/store';
+import { MultiLanguageText, OrderDiscount } from '../models';
+import { ServeType } from '../enums';
+import { SOPublicMenu, SOPublicCategory, SOPublicProduct, SOPublicProductAttribute, SOPublicProductAttributeCategory, SOPaymentMethod, SOValidateCart, SOOrderState, SOOrder, SOEater } from '../models/online-ordering';
+/**
+ * SO = SDIT Online
+ */
+/*******************************/
+/**  SOGetStoreInfo */
+/*******************************/
+export interface SOGetStoreInfoRequest {
+    storeId: string;
+}
+export interface SOGetStoreInfoResponse {
+    storeId: string;
+    /**
+     * 線上店名
+     * @Default 店內名稱
+     */
+    storeName: string;
+    /**
+     * 聯絡電話
+     */
+    phone?: string;
+    /**
+     * 店址
+     */
+    address?: Address;
+    /**
+     * 線上店營業時間
+     *  @Default []
+     */
+    openingHours: DayOfWeekTimePeriod[];
+    /**
+     * 橫幅
+     */
+    bannerConfig: GalleryConfig;
+    /**
+     * 點餐公告
+     * @Default {zh-TW: ''}
+     */
+    orderAnnouncement: MultiLanguageText;
+    /**
+     * 結帳公告
+     * @Default {zh-TW: ''}
+     */
+    checkoutAnnouncement: MultiLanguageText;
+    /**
+     * 關閉訂單備註輸入
+     * @Default false
+     */
+    orderNoteHidden: boolean;
+    /**
+     * 關閉訂單品項備註輸入
+     * @Default false
+     */
+    orderItemNoteHidden: boolean;
+    /**
+     * 關閉統編輸入
+     * 若沒啟用統一發票強制 false
+     * @Default false
+     */
+    buyerIdInputHidden: boolean;
+    /**
+     * 線上店到untilOpen之後可接單
+     * 設Infinity為永久停業
+     * @Default null
+     */
+    untilOpen: number;
+    /**
+     * 是否使用線上點餐
+     * @Default false
+     */
+    enabled: boolean;
+    /**
+     * 線上點餐支付方式
+     * @Default [現場付款]
+     */
+    paymentMethods: SOPaymentMethod[];
+    /**
+     * 線上點餐預計等待時間(分)
+     * @Default 30
+     */
+    onlineEstimatedReadyForPickupTime: number;
+}
+/*******************************/
+/*******************************/
+export interface SOGetStoreMenuRequest {
+    storeId: string;
+    /**
+     *  undefined: 現在
+     */
+    when?: number;
+}
+export interface SOGetStoreMenuResponse {
+    menus: SOPublicMenu[];
+    categories: SOPublicCategory[];
+    products: SOPublicProduct[];
+    /**
+     * 只顯示可見的註記
+     */
+    attributes: SOPublicProductAttribute[];
+    /**
+     * 只顯示可見的註記類別
+     */
+    attributeCategories: SOPublicProductAttributeCategory[];
+}
+/*******************************/
+/*******************************/
+export interface SOValidateMutationRequest {
+    storeId: string;
+    traceId: string;
+    /**
+     * 預計取餐時間 timestamp ms
+     * 不給值 = 盡快
+     */
+    expectedPickupAt?: number;
+    cart: SOValidateCart;
+}
+/**
+ * @throw `SOOrderError`
+ */
+export interface SOValidateMutationResponse {
+    storeId: string;
+    traceId: string;
+    /**
+     * 小計
+     */
+    subtotal: number;
+    /**
+     * 折扣
+     */
+    discount: OrderDiscount;
+    /**
+     * 總折扣金額
+     */
+    totalDiscountAmount: number;
+    /**
+     * 結帳金額
+     */
+    totalAmount: number;
+}
+/*******************************/
+/*******************************/
+export interface SOSendOrderRequest {
+    storeId: string;
+    serveType: ServeType;
+    eater: SOEater;
+    cart: SOValidateCart;
+    /**
+     * 是否為現場付款
+     * 選擇現場付款的訂單，會馬上成立無法再改付款方式。
+     */
+    isOnSitePayment: boolean;
+    /**
+     *  包裝、免洗餐具
+     */
+    includeDisposableItems: boolean;
+    /**
+     * 預計取餐時間 timestamp ms
+     * 不給值 = 盡快
+     */
+    expectedPickupAt?: number;
+}
+/**
+ * @throw `SOOrderError`
+ */
+export interface SOSendOrderResponse {
+    /** online Order Id */
+    id: string;
+    state: SOOrderState;
+    /** 消費者識別用 id的末五碼 == Order.serialNumber */
+    displayId: string;
+    isOnSitePayment: boolean;
+}
+/*******************************/
+/*******************************/
+export interface SOGetPaymentUrlRequest {
+    storeId: string;
+    /** online Order Id */
+    id: string;
+    /**
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    successReturnUrl?: string;
+    /**
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    failureReturnUrl?: string;
+}
+export interface SOGetPaymentUrlResponse {
+    payUrl: string;
+}
+/*******************************/
+/*******************************/
+export interface SOCancelOrderRequest {
+    storeId: string;
+    /** online order id */
+    id: string;
+}
+export interface SOCancelOrderResponse {
+    storeId: string;
+    /** online order id */
+    id: string;
+    state: SOOrderState;
+}
+/*******************************/
+/*******************************/
+export interface SOGetOrderRequest {
+    storeId: string;
+    /** online order id */
+    id: string;
+}
+export interface SOGetOrderResponse {
+    storeId: string;
+    order: SOOrder;
+}
+/*******************************/
+/*******************************/
+export interface SOChangeStoreStatusRequest {
+    storeId: string;
+    operator?: Operator;
+    isOpen: boolean;
+    enabled: boolean;
+}
+export declare type SOChangeStoreStatusResponse = null;