@lemoncloud/ssocio-stacks-api 0.23.1212 → 0.24.107

package/dist/service/backend-types.d.ts

@@ -101,7 +101,20 @@ export declare type TimeBlock = {
     T1: string;
     /** T2: 마감 시간 */
     T2: string;
+    /** index of day of week */
+    week?: number;
 };
+/**
+ * type: `TimeElement$`
+ * - 여러 요일의 운영 시간을 저장하기 위함.
+ */
+export interface TimeElement$ {
+    /**
+     * key := <number>
+     * val := TimeBlock
+     */
+    [key: number]: TimeBlock;
+}
 /**
  * type: `DayOfTheWeekPolicy`
  * - 프로그램 등록에서 시간 신청 관리시, 요일 정책 추가를 위해 사용됨.
@@ -133,30 +146,6 @@ export declare type Segment = {
     /** name of zone */
     name?: string;
 };
-/**
- * type: `OrderOption`
- * - 옵션 주문 선택을 위한 파라미터.
- */
-export declare type OrderOption = {
-    /** id of option-model */
-    id?: string;
-    /** selected count of option. */
-    count?: number;
-    /** (optional) total discount */
-    discount?: number;
-};
-/**
- * type: `AgreedOption`
- * - 약관 동의 선택을 위한 파라미터
- */
-export declare type AgreedOption = {
-    /** id of agreed-model */
-    id?: string;
-    /** type of agrees */
-    type?: AgreedType;
-    /** agreement name */
-    name?: string;
-};
 /**
  * type: `User`
  * - 프로그램 예약 후, 주문자 정보를 저장하기 위함.
@@ -175,6 +164,26 @@ export interface User {
     /** ho-name (ex: 203) in address */
     addrHo?: string;
 }
+/**
+ * type: `Instructor`
+ * - 최소한의 강사 정보를 저장하기 위함. (linked `ssocio2-backend-api`)
+ */
+export interface Instructor {
+    /** 강사명 */
+    name?: string;
+    /** 닉네임 */
+    nick?: string;
+    /** 연락처 */
+    phone?: string;
+    /** 강사 이미지 */
+    images?: string[];
+    /** 태그 항목 */
+    tags?: string[];
+    /** 이력 정보 (TBD) */
+    histories?: string[];
+    /** id of origin */
+    originId?: string;
+}
 /**
  * type: `Unit`
  */
@@ -194,6 +203,63 @@ export interface Unit {
     /** expired time of unit (timestamp) */
     expiredAt?: number;
 }
+/**
+ * type: `Slot`
+ * - 좌석형 프로그램의 기본 인스턴스 정보.
+ * @see ssocio-zacs-api
+ */
+export interface Slot {
+    /** 해당 슬롯의 시작 시각 정보 */
+    slotStartTime?: number;
+    /** 해당 슬롯의 종료 시각 정보 */
+    slotEndTime?: number;
+    /**
+     * 해당 슬롯의 시작 구간
+     * - ex) "20:00"
+     */
+    slotT1?: string;
+    /**
+     * 해당 슬롯의 종료 구간
+     * - ex) "21:00"
+     */
+    slotT2?: string;
+    /** 해당 날짜의 텍스트 */
+    fullDate?: string;
+    /** 해당 날짜의 요일 */
+    dayOfAWeek?: number;
+    /** 설정된 시분할 기준값 (분) */
+    duration?: number;
+    /** 해당 슬롯의 판매일 여부 */
+    isBusinessDay?: BoolFlag;
+    /** 해당 슬롯의 공휴일 여부 */
+    isHoliday?: BoolFlag;
+    /** 해당 슬롯의 할인일 여부 */
+    isSaleDay?: BoolFlag;
+    /** 해당 슬롯의 예약제한 여부 */
+    isDisableDay?: BoolFlag;
+    /** flag of invalid */
+    invalid?: BoolFlag;
+    /** (link) 시간과 매핑된 구역의 ID */
+    zoneId?: string;
+}
+/**
+ * type: `ProdSaleConditionType`
+ * - 신청관리모델에 설정된 판매 금액 및 조건을 확정하기 위한 타입 (ApplicationManagementModel)
+ */
+export interface ProdSaleConditionType {
+    /** 신청관리타입 */
+    stereo?: ManagementStereoType;
+    /** 최종 산정 가격 */
+    prodPrice?: number;
+    /** (optional) 설정된 시간 분할 단위 (분) */
+    saleInterval?: number;
+    /** (optional) 최종 시간 분할 단위 (분) */
+    prodInterval?: number;
+}
+/**
+ * type: boolean style number.
+ */
+export declare type BoolFlag = 0 | 1;
 /**
  * Lookup Table
  */
@@ -219,11 +285,42 @@ export declare const $LUT: {
         seat: string;
         /** 숙박 */
         room: string;
+        /** 이용권 */
+        pass: string;
         /** 옵션상품 */
         option: string;
         /** 약관설정 */
         agreed: string;
     };
+    /** Program Stereo Type */
+    ProgramStereo: {
+        /** 프로그램 */
+        program: string;
+        /** 좌석 */
+        seat: string;
+        /** 숙박 */
+        room: string;
+        /** 이용권 */
+        pass: string;
+    };
+    /**
+     * Seat Stereo Type
+     */
+    SeatStereoType: {
+        '': string;
+        /** 스크린골프 */
+        golf: string;
+        /** 독서실 */
+        reading: string;
+    };
+    /**
+     * Pass Stereo Type
+     */
+    PassStereoType: {
+        '': string;
+        /** 발급 */
+        activity: string;
+    };
     /** Zac Stereo Type (상품 생성 코드 타입) */
     ZacStereo: {
         /** 단일 생성 */
@@ -233,16 +330,16 @@ export declare const $LUT: {
     };
     /** Management Stereo Type (신청 관리 타입) */
     ManagementStereo: {
-        /** 기간 신청 관리 */
+        /** 기간 신청 관리 (P) */
         period: string;
-        /** 시간 신청 관리 */
-        time: string;
-        /** 쿠폰 신청 관리 */
-        coupon: string;
-        /** 매칭 상품 */
-        match: string;
-        /** 숙박 일정 관리  */
+        /** 숙박 일정 관리 (G) */
         room: string;
+        /** 시간 신청 관리 (O)*/
+        time: string;
+        /** 일권 신청 관리 (O) */
+        daily: string;
+        /** 월권(좌석) 신청 관리 (O) */
+        monthly: string;
     };
     /** Product Type (상품 타입) */
     ProductType: {
@@ -252,8 +349,19 @@ export declare const $LUT: {
         dailyPass: string;
         /** 시간권 */
         timePass: string;
-        /** 횟수권 */
-        countPass: string;
+    };
+    /** PassOperationType (이용권 관리 타입) */
+    PassOperationType: {
+        /** 시간권 */
+        timely: string;
+        /** 일권 */
+        daily: string;
+        /** 월권 */
+        monthly: string;
+        /** 월이용권 (횟수) */
+        count: string;
+        /** 공동부과 */
+        joint: string;
     };
     /** 달 (Month) */
     Month: {
@@ -376,6 +484,8 @@ export declare const $LUT: {
     };
     /** 시간 신청 관리 세부 기준 (BaseTimeType) */
     BaseTimeType: {
+        /** day: 일수 기준 */
+        day: string;
         /** hour: 시간당 기준 */
         hour: string;
         /** minute: 분 */
@@ -391,6 +501,8 @@ export declare const $LUT: {
         C: string;
         /** D type */
         D: string;
+        /** E type */
+        E: string;
     };
     /**
      * 요일 (WeekDay)
@@ -434,11 +546,45 @@ export declare const $LUT: {
         /** 수강종료 */
         finished: string;
     };
+    /**
+     * Reserve Limit Target Type
+     * - 예약 제한 타입
+     */
+    ReserveLimitTarget: {
+        /** no selection */
+        '': string;
+        /** 개인 */
+        individual: string;
+        /** 세대 */
+        household: string;
+    };
+    /**
+     * PassStateType
+     * - 이용권 상태 타입
+     */
+    PassStateType: {
+        /** 적용가능 */
+        canUse: string;
+        /** 적용불가 */
+        notMatch: string;
+        /** 재고없음 (수량) */
+        soldout: string;
+        /** 1일 사용횟수 초과 */
+        overDailyLimit: string;
+        /** 사용기간아님 */
+        notUsePeriod: string;
+        /** 권한없음 */
+        noPermission: string;
+    };
 };
 /**
  * type: `CategoryStereoType`
  */
 export declare type CategoryStereoType = keyof typeof $LUT.CategoryStereo;
+/**
+ * type: `ProgramStereoType`
+ */
+export declare type ProgramStereoType = keyof typeof $LUT.ProgramStereo;
 /**
  * type: `ZacStereoType`
  */
@@ -519,6 +665,26 @@ export declare type CancelPeriodType = keyof typeof $LUT.CancelPeriod;
  * type: `PushTargetType`
  */
 export declare type PushTargetType = keyof typeof $LUT.PushTarget;
+/**
+ * type: `SeatStereoType`
+ */
+export declare type SeatStereoType = keyof typeof $LUT.SeatStereoType;
+/**
+ * type: `ReserveLimitTargetType`
+ */
+export declare type ReserveLimitTargetType = keyof typeof $LUT.ReserveLimitTarget;
+/**
+ * type: `PassStereoType`
+ */
+export declare type PassStereoType = keyof typeof $LUT.PassStereoType;
+/**
+ * type: `PassOperationType`
+ */
+export declare type PassOperationType = keyof typeof $LUT.PassOperationType;
+/**
+ * type: `PassStateType`
+ */
+export declare type PassStateType = keyof typeof $LUT.PassStateType;
 /**
  * query param for category-list
  */
@@ -536,12 +702,20 @@ export interface CategoryListParam extends PaginateParam {
 export interface ProgramListParam extends PaginateParam {
     /** sort selection: (format: <field>:<asc|desc?>, ex: price, price:desc ) */
     sort?: 'latest' | 'popular' | 'lowPrice' | 'highPrice';
+    /** filter by name */
+    name?: string;
+    /** filter by date (ex: '2024-01-01') */
+    from?: string;
+    /** filter by date (ex: '2024-01-30') */
+    to?: string;
     /** filter by category-id */
     categoryId?: string;
     /** filter by stereo type */
     stereo?: string;
     /** filter `isDisplay` condition (default true) */
     display?: boolean | string;
+    /** show the detail infor (default true) */
+    detail?: boolean | string;
     /** include stock view */
     useStock?: boolean;
 }
@@ -551,6 +725,8 @@ export interface ProgramListParam extends PaginateParam {
 export interface OptionListParam extends PaginateParam {
     /** sort selection: (format: <field>:<asc|desc?>, ex: price, price:desc ) */
     sort?: 'latest' | 'popular' | 'lowPrice' | 'highPrice';
+    /** filter by name */
+    name?: string;
     /** filter by category-id */
     categoryId?: string;
     /** filter by stereo type */
@@ -608,6 +784,74 @@ export interface LimitListParam extends PaginateParam {
     /** filter by program-ids */
     programIds?: string[];
 }
+/**
+ * query param for passes-list
+ */
+export interface PassListParam extends PaginateParam {
+    sort?: 'latest' | 'popular';
+    /**
+     * where to view
+     * - main일 경우 본인 이용권만 보이도록.
+     */
+    view?: '' | 'mine';
+    /**
+     * filter by startedAt (like = "2024-06-17 00:00:00")
+     * - 이용가능 기간 중, 시작 시각
+     */
+    from?: string;
+    /**
+     * filter by endAt (like = "2024-06-20 23:00:00")
+     * - 이용가능 기간 중, 종료 시각
+     */
+    to?: string;
+    /** filter by user-id  */
+    userId?: string;
+    /** filter by prod(program)-id
+     * - 상품 적용가능 여부 필터링을 위함.
+     */
+    prodId?: string;
+}
+/**
+ * query param for seats-list
+ */
+export interface SeatListParam extends PaginateParam {
+    /** sort selection: (format: <field>:<asc|desc?>, ex: price, price:desc ) */
+    sort?: 'latest' | 'popular' | 'lowPrice' | 'highPrice';
+    /** filter by startedAt (ex: 2024-01-01)
+     * - 좌석 시작 일자
+     */
+    from?: string;
+    /** filter by endAt (ex: 2024-01-03)
+     * - 좌석 종료 일자
+     */
+    to?: string;
+    /** filter by zone-ids */
+    zoneIds?: string[];
+    /** filter by date */
+    date?: string;
+    /** filter by user-id (tenant) */
+    userId?: string;
+    /**
+     * flag to filter by assigned status
+     * - "": 날짜별 할당되지 않은 예약 개수 보임.
+     * - "!": 날짜별 할당된 예약 개수 보임.
+     */
+    assigned?: string;
+    /**
+     * flag to filter by canceled status
+     * - "": 날짜별 취소 되지 않은 예약 개수 보임.
+     * - "!": 날짜별 취소된 예약 개수 보임.
+     */
+    canceled?: string;
+    /** filter by block of house (단지) */
+    block?: string;
+    /** filter by dong of dong (동) */
+    dong?: string;
+    /** fi lter by ho of house (호) */
+    ho?: string;
+    /** flag of full-list */
+    readonly fetchAll?: boolean;
+}
 /**
  * param for tile (세분 목록 시간(tile) 조회를 위한 파라미터)
  */
@@ -623,3 +867,20 @@ export interface TileParam {
     /** type of product */
     type?: ProdType;
 }
+/**
+ * 좌석 조회를 위한 파라미터
+ */
+export interface SeatCalendarParam {
+    /**
+     * target date (like '2023-04-28')
+     */
+    date?: string;
+    /**
+     * id of zone
+     */
+    zoneId?: string;
+    /** start date of period search (like '2027-07-01') */
+    from?: string;
+    /** end date of period search (like '2027-07-01') */
+    to?: string;
+}