@trusted-solutions/sdit.models 0.24.0 → 0.24.2

package/lambda/contract.d.ts

@@ -56,6 +56,16 @@ export interface UpdateContractPlanRequest {
      * Will ignore `planId` if provided.
      */
     planIds?: string[];
+    /**
+     * undefined: 不變更
+     * null/空字串: 移除此property
+     */
+    name?: string;
+    /**
+     * undefined: 不變更
+     * null/空字串: 移除此property
+     */
+    note?: string;
 }
 export declare type UpdateContractPlanResponse = null;
 /**

package/lambda/subscription.d.ts

@@ -0,0 +1,111 @@
+import { Contract } from '../models/contract';
+export declare enum SubscriptionVariantType {
+    month = "M",
+    year = "Y"
+}
+export declare type Subscription = {
+    id: string;
+    createdAt: number;
+    externalId?: string;
+    storeId: string;
+    ownerCognitoUserId: string;
+    ownerCognitoUserEmail: string;
+    ownerCognitoUserName: string;
+    externalCustomerId: string;
+    variantType: SubscriptionVariantType;
+    details: SubscriptionItem[];
+    totalAmount: number;
+    startedAt: number;
+    endedAt?: number;
+    autoRenew: boolean;
+    contract: Contract;
+};
+export interface SubscriptionItem {
+    id: string;
+    name: string;
+    amount: number;
+    planId: string;
+}
+export interface SubscriptionVariantOption {
+    type: SubscriptionVariantType;
+    name: string;
+}
+export interface SubscriptionProductOption {
+    id: string;
+    name: string;
+    variant: {
+        [key in SubscriptionVariantType]: {
+            amount: number;
+            description?: string;
+        };
+    };
+    planId: string;
+    description?: string;
+}
+export interface SubscriptionOption {
+    products: SubscriptionProductOption[];
+    variants: SubscriptionVariantOption[];
+}
+export declare type SubscribeAndGetPaymentUrlRequest = {
+    ip?: string;
+    storeId: string;
+    ownerCognitoUserId: string;
+    externalCustomerId: string;
+    variantType: SubscriptionVariantType;
+    subscriptionProductIds: string[];
+    startedAt: number | null;
+    autoRenew: boolean;
+    /**
+     * 付款成功後的跳轉網址
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    successReturnUrl?: string;
+    /**
+     * 付款失敗後的跳轉網址
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    failureReturnUrl?: string;
+};
+export declare type SubscribeGetPaymentUrlResponse = {
+    payUrl: string;
+};
+export declare type EnableAutoRenewAndGetPaymentUrlRequest = {
+    subscriptionId: string;
+    ip?: string;
+    /**
+     * 付款成功後的跳轉網址
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    successReturnUrl?: string;
+    /**
+     * 付款失敗後的跳轉網址
+     * 以MyPay為例
+     * 可在產生付款網址時，決定returnUrl
+     * 若不填寫，則以MyPay特約店家後台設定的為主
+     */
+    failureReturnUrl?: string;
+};
+export declare type GetSubscriptionStatusRequest = {
+    storeId: string;
+};
+export declare type GetSubscriptionStatusResponse = {
+    currentSubscription: Subscription;
+    originalSubscription: Subscription;
+    upcomingSubscription: Subscription;
+    /** 反查 Posky 原加值服務是否已經付費2023年的發票。若沒有綁定Posky store_no 那一律回傳false */
+    isSubscribeInvoice2023: boolean;
+};
+export declare type StopSubscriptionRequest = {
+    storeId: string;
+    subscriptionId: string;
+};
+export declare type StopSubscriptionResponse = Subscription;
+export declare type DeleteSubscriptionRequest = {
+    subscriptionId: string;
+};

package/lambda/subscription.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubscriptionVariantType = void 0;
+var SubscriptionVariantType;
+(function (SubscriptionVariantType) {
+    SubscriptionVariantType["month"] = "M";
+    SubscriptionVariantType["year"] = "Y";
+})(SubscriptionVariantType = exports.SubscriptionVariantType || (exports.SubscriptionVariantType = {}));
+//# sourceMappingURL=subscription.js.map

package/lambda/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../../projects/sdit-model-lib/src/lambda/subscription.ts"],"names":[],"mappings":";;;AAEA,IAAY,uBAGX;AAHD,WAAY,uBAAuB;IACjC,sCAAW,CAAA;IACX,qCAAU,CAAA;AACZ,CAAC,EAHW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAGlC"}

package/models/contract.d.ts

@@ -15,9 +15,9 @@ export declare type ContractCore = {
     name: string;
     note?: string;
     startedAt: number;
-    /** 不給: 由後端參考plan給值; 給了: 後端直接用這個值 */
-    endedAt?: number;
-    planId: string;
+    endedAt: number;
+    /** planId, planIds 二選一填 */
+    planId?: string;
     planIds?: string[];
     storeId: string;
     ownerCognitoUserId: string;
@@ -28,5 +28,5 @@ export declare type Contract = {
     createdAt: number;
     endedAt: number;
     plan: Plan;
-    plans?: Plan[];
+    plans: Plan[];
 } & ContractCore;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trusted-solutions/sdit.models",
-  "version": "0.24.0",
+  "version": "0.24.2",
   "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": {