@trusted-solutions/sdit.models 0.62.0-alpha.1 → 0.62.0-alpha.6

package/lambda/online-ordering.d.ts

@@ -1,7 +1,7 @@
 import { Address, DayOfWeekTimePeriod, GalleryConfig, Operator, PointProvider } from '../models/store';
 import { CustomerPointDetail, MultiLanguageText, OrderDiscount } from '../models';
 import { PaymentServiceProvider, ServeType } from '../enums';
-import { SOPublicMenu, SOPublicCategory, SOPublicProduct, SOPublicProductAttribute, SOPublicProductAttributeCategory, SOPaymentMethod, SOValidateCart, SOOrderState, SOOrder, SOEater, SOPublicDiscountRule, SOMemberCoupon } from '../models/online-ordering';
+import { SOPublicMenu, SOPublicCategory, SOPublicProduct, SOPublicProductWithContext, SOPublicProductAttribute, SOPublicProductAttributeCategory, SOPaymentMethod, SOValidateCart, SOOrderState, SOOrder, SOEater, SOPublicDiscountRule, SOMemberCoupon } from '../models/online-ordering';
 import { RoundingMode } from '../enums/rounding-mode.enum';
 import { MultipleItems } from './response';
 /**
@@ -230,7 +230,23 @@ export interface SOGetStoreMenuResponse {
      */
     attributeCategories: SOPublicProductAttributeCategory[];
 }
+export interface SOGetPopularProductsRequest {
+    storeId: string;
+    when?: number;
+    serveType?: ServeType;
+}
+export interface SOGetPopularProductsResponse extends MultipleItems<SOPublicProductWithContext> {
+}
+export interface SOGetBestPairingsRequest {
+    storeId: string;
+    productId: string;
+    when?: number;
+    serveType?: ServeType;
+}
+export interface SOGetBestPairingsResponse extends MultipleItems<SOPublicProductWithContext> {
+}
 export interface SOGetMyMemberCouponsRequest {
+    storeId: string;
     limit?: number;
     paginationToken?: string;
 }

package/lambda/request/kiosk.d.ts

@@ -13,3 +13,72 @@ export interface GetKiosksRequest {
     userId: string;
     storeId: string;
 }
+export interface GetKioskConfigRequest {
+    storeId: string;
+}
+export interface GetKioskMenuRequest {
+    storeId: string;
+}
+export interface GetKioskCouponByQrRequest {
+    qr: string;
+}
+export interface GetMemberRequest {
+    memberPoolNo: string;
+    memberNo?: string;
+    phone?: string;
+    qrcode?: string;
+}
+export interface RedeemPointDryRunOrderItem {
+    name: string;
+    quantity: number;
+}
+export interface RedeemPointDryRunRequest {
+    storeId: string;
+    customer: {
+        cognitoUserId: string;
+        memberPoolNo: string;
+        email?: string;
+        phone?: string;
+    };
+    orderContext: {
+        id: string;
+        storeId: string;
+        createdAt: number;
+        expectedPickupAt?: number | null;
+        items: RedeemPointDryRunOrderItem[];
+        totalAmount: number;
+        totalBeforePoints?: number;
+        totalDiscountAmount?: number;
+    };
+}
+export interface RedeemPointRequest {
+    storeId: string;
+    customer: {
+        cognitoUserId: string;
+        memberPoolNo: string;
+        email?: string;
+        phone?: string;
+    };
+    points: {
+        redeemPoints: number;
+        redeemAmount?: number;
+        [key: string]: unknown;
+    };
+    orderContext: {
+        id: string;
+        storeId: string;
+        createdAt: number;
+        expectedPickupAt?: number | null;
+        items: RedeemPointDryRunOrderItem[];
+        totalAmount: number;
+        totalBeforePoints?: number;
+        totalDiscountAmount?: number;
+    };
+}
+export interface RedeemCouponRequest {
+    memberCouponNo: string;
+    orderNo: string;
+    storeNo: number;
+    brandNo?: string;
+    brandExternalId?: number;
+}

package/lambda/request/user.d.ts

@@ -7,6 +7,7 @@ export interface CreateUserRequest {
     temporaryPassword: string;
     group: UserGroupEnum;
     userAttributes?: UserAttribute[];
+    suppressEmail?: boolean;
 }
 export interface EnableUserRequest {
     userPoolId: string;

package/lambda/response/kiosk.d.ts

@@ -1,5 +1,7 @@
-import { Kiosk } from "../../models";
+import { Kiosk, Store } from "../../models";
+import { BaseRuleModel } from "../../models";
 import { SingleItem, MultipleItems } from "./common";
+import { SOGetStoreMenuResponse } from "../online-ordering";
 /**
  * Lambda result to kiosk-admin
  */
@@ -10,3 +12,77 @@ export interface CreateKioskResponse extends SingleItem<Kiosk> {
  */
 export interface GetKiosksResponse extends MultipleItems<Kiosk> {
 }
+export interface GetKioskConfigResponse extends SingleItem<Store> {
+}
+export interface GetKioskMenuResponse extends Omit<SOGetStoreMenuResponse, 'discountRules'> {
+    discountRules: BaseRuleModel[];
+}
+export declare type PoskyCrmMemberCouponStatus = string;
+export declare type PoskyCrmMemberCouponListItem = {
+    memberCouponNo: string;
+    name: string;
+    description: string;
+    notice?: string | null;
+    status: PoskyCrmMemberCouponStatus;
+    startDatetime: string;
+    endDatetime: string;
+};
+export declare type PoskyCrmCouponDiscountRuleDetail = Omit<BaseRuleModel, 'discountRuleNo' | 'applyMethod' | 'note'> & {
+    discountRuleNo: string | number;
+    applyMethod: 'AutoApply' | 'Coupon';
+    note?: string | null;
+};
+export declare type PoskyCrmMemberCouponDetail = PoskyCrmMemberCouponListItem & {
+    brandNo: string;
+    memberNo: string;
+    state: PoskyCrmMemberCouponStatus;
+    redeemedDatetime?: string | null;
+    redeemedOrderNo?: string | null;
+    redeemedStoreNo?: number | null;
+    voidReason?: string | null;
+    createDatetime: string;
+    discountRuleDetail: PoskyCrmCouponDiscountRuleDetail;
+    redeemEligibility: {
+        canRedeem: boolean;
+        reason?: string;
+    };
+};
+export declare type PoskyCrmMemberCouponDetailByQr = Omit<PoskyCrmMemberCouponDetail, 'memberNo'> & {
+    notice?: string | null;
+    member: {
+        memberNo: string;
+        memberPoolNo: string;
+        name: string;
+        carrier?: string;
+    };
+};
+export interface GetMemberResponse {
+    memberNo: string;
+    memberPoolNo: string;
+    idpSub: string | null;
+    name: string;
+    birthday: string | null;
+    gender: number | null;
+    email: string | null;
+    phoneNumber: string | null;
+    address: string | null;
+    carrier: string | null;
+    totalPoints: number;
+    expiringPoints: number;
+    expirationDatetime: string | null;
+}
+export declare type GetKioskCouponByQrResponse = PoskyCrmMemberCouponDetailByQr;
+export interface RedeemPointDryRunResponse {
+    usedPoints: number;
+    discountAmount: number;
+    errorMessage?: string;
+}
+export declare type RedeemPointResponse = {
+    usePoints: number;
+    discountAmount: number;
+    tradeDatetime: string;
+    errorMessage?: string;
+} | null;
+export interface RedeemCouponResponse {
+    redeemedDatetime: string;
+}

package/models/customer.d.ts

@@ -8,14 +8,19 @@ export interface Customer {
     id?: string;
     name: string;
     phone: string;
+    address?: string;
     /** Pool ID 不填，為早期cognito User Pool  */
     memberPoolNo?: string;
     /** 同一個Pool下的唯一user ID  */
     cognitoUserId?: string;
     cardNo?: string;
+    carrier?: string;
     gender?: CustomerGenderEnum;
     email?: string;
     birthday?: CustomerBirthday;
+    totalPoints?: number;
+    expiringPoints?: number;
+    expirationDatetime?: string;
     totalVisits?: number;
     totalSpending?: number;
     firstVisitTime?: number;

package/models/discount-module/discount-module.d.ts

@@ -43,6 +43,20 @@ export interface DiscountMethod {
     type: DiscountMethodTypeEnum;
     value: number;
 }
+export interface BaseRuleModel {
+    discountRuleNo: string | number;
+    applyMethod: "AutoApply" | "Coupon";
+    name: string;
+    description?: string;
+    note?: string | null;
+    beginDatetime: string;
+    endDatetime: string;
+    isActive: number;
+    targetCustomers: any;
+    useCondition: any;
+    moduleType: string;
+    modulePayload: any;
+}
 export declare type UnionOfDiscountModule = EntireOrderDiscountModule | SelectedItemDiscountModule;
 export declare type UnionOfDiscountItem = SelectedItemDiscountItem;
 export interface EntireOrderDiscountModuleChoices {

package/models/online-ordering.d.ts

@@ -271,6 +271,11 @@ export interface SOPublicProduct {
     type?: ProductType;
     isComboOnly?: boolean;
 }
+export interface SOPublicProductWithContext {
+    menuId: string;
+    categoryId: string;
+    product: SOPublicProduct;
+}
 export interface DiscountLabel {
     i18nKey: string;
     i18nParams: Record<string, any>;

package/models/order.d.ts

@@ -293,6 +293,10 @@ export interface OrderPayment {
     transactionId: string;
     /**  PaidAt provided by third party payment vendor after payment. */
     paidAt: number;
+    cardBrand?: string;
+    maskedCardNo?: string;
+    terminalId?: string;
+    merchantId?: string;
     /**  Used to record the payment results provided by third-party payment vendor */
     detail: any;
     /**  Used to record info of refund. */

package/models/payment-config.d.ts

@@ -83,7 +83,7 @@ export interface DdpayOnlineConfig extends BasePaymentConfig {
 }
 export interface DdpayConfig extends BasePaymentConfig {
     provider: PaymentServiceProvider.ddpay;
-    type: PaymentType.unknown;
+    type: PaymentType.unknown | PaymentType.kioskSelfCheckout;
     clientId: string;
     clientSecret: string;
     shopId: string;
@@ -102,3 +102,8 @@ export interface NewebpayOnlineConfig extends BasePaymentConfig {
     hashKey: string;
     hashIV: string;
 }
+export interface NewebpayConfig extends BasePaymentConfig {
+    provider: PaymentServiceProvider.newebpay;
+    type: PaymentType.creditCard;
+    adminPassword: string;
+}

package/models/receipt.d.ts

@@ -54,6 +54,10 @@ export interface Transaction {
     transactionId: string;
     /**  PaidAt provided by third party payment vendor after payment. */
     timestamp: number;
+    cardBrand?: string;
+    maskedCardNo?: string;
+    terminalId?: string;
+    merchantId?: string;
     /**  Used to record the payment results provided by third-party payment vendor */
     detail: any;
     operator?: Operator;

package/models/store.d.ts

@@ -21,6 +21,29 @@ export interface Operator {
     storeUserId: string;
     name: string;
 }
+export declare type Brand = {
+    brandNo: string;
+    memberPoolNo: string;
+    clientId: string;
+    name: string;
+    introduction: string;
+    logoUrl: string;
+    themeColor: {
+        primary: string;
+        primaryRgb: string;
+        primaryTint: string;
+        primaryShade: string;
+        primaryContrast: string;
+        primaryContrastRgb: string;
+    };
+    mainStoreNo: number;
+    createEmployeeNo: number;
+    createDatetime: string;
+    lastEditEmployeeNo: number;
+    lastEditDatetime: string;
+    isActive: number;
+    isDel: number;
+};
 export interface Store {
     id?: string;
     /** 讓店家自行定義的店號，會印在發票及收據上 */
@@ -225,6 +248,10 @@ export interface Store {
     onlineStorePointsName?: string;
     /** 品牌 */
     brandNo?: string;
+    brand?: Brand;
+    storePointsEnabled?: boolean;
+    storePointsProvider?: PointProvider;
+    storePointsName?: string;
     /** 加入購物車時，是否與相同品相合併 */
     onlineMergeSameItem?: boolean;
     /** 內用服務費 1~100(%) undefined為關閉 */

package/models/store.js.map

@@ -1 +1 @@
-{"version":3,"file":"store.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/store.ts"],"names":[],"mappings":";;;AAEA,oCAAmH;AAuQnH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,kDAAiC,CAAA;AACnC,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/store.ts"],"names":[],"mappings":";;;AAEA,oCAAmH;AAkSnH,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,gCAAe,CAAA;IACf,kDAAiC,CAAA;AACnC,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB"}

package/models/table.d.ts

@@ -3,6 +3,7 @@ export interface ServeConfig {
     disableTakeOut: boolean;
     disableDineIn: boolean;
     dineInInputType: ServeInputType;
+    tableId?: string;
 }
 export interface BaseTable {
     id?: string;

package/models/table.js.map

@@ -1 +1 @@
-{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/table.ts"],"names":[],"mappings":";;;AA0BA,IAAY,cAIX;AAJD,WAAY,cAAc;IACtB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,+BAAa,CAAA;AACjB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}
+{"version":3,"file":"table.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/models/table.ts"],"names":[],"mappings":";;;AA2BA,IAAY,cAIX;AAJD,WAAY,cAAc;IACtB,yCAAuB,CAAA;IACvB,yCAAuB,CAAA;IACvB,+BAAa,CAAA;AACjB,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trusted-solutions/sdit.models",
-  "version": "0.62.0-alpha.1",
+  "version": "0.62.0-alpha.6",
   "description": "TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.",
   "main": "index.js",
   "scripts": {