@lemoncloud/ssocio-stacks-api 0.23.1008 → 0.24.106

package/dist/view/types.d.ts

@@ -8,8 +8,10 @@
  * @copyright (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
  */
 import { View, Body } from '../cores/types';
-import { TestModel, ProgramModel, CategoryModel, PaymentModel, CancelModel, DisplayModel, PushNotificationModel, ProgramOperatorModel, ApplicationManagementModel, PolicyModel, OptionModel, AgreedModel, TileModel, FaultModel, StockModel, RoomModel, LimitModel } from '../service/backend-model';
-import { AgreedOption, CategoryStereoType, OrderOption, Segment, Unit } from '../service/backend-types';
+import { TestModel, ProgramModel, CategoryModel, PaymentModel, CancelModel, DisplayModel, PushNotificationModel, ProgramOperatorModel, ApplicationManagementModel, PolicyModel, OptionModel, AgreedModel, StockModel, RoomModel, LimitModel, GuidelineModel, SeatModel, PassModel, PassOpsModel } from '../service/backend-model';
+import { AgreedType, ComissionRate, ProgramStereoType, RefundType, ReserveLimitTargetType, Segment, ServiceStatus, TimeBlock, Unit, WeekDayType } from '../service/backend-types';
+import { SeatStateType } from '../lib/seats-types';
+export * from '../service/backend-types';
 /**
  * type: `CategoryView`
  */
@@ -25,7 +27,7 @@ export interface CategoryBody extends Body, Partial<CategoryView> {
 /**
  * type: `ProgramView`
  */
-export interface ProgramView extends View, Omit<Partial<ProgramModel>, 'payment$' | 'cancel$' | 'display$' | 'application$' | 'push$' | 'operator$' | 'tile$' | 'room$' | 'fault' | 'isDisplay' | 'useOperatorDisplay' | 'useImage' | 'useFacilityInfo' | 'useAutoExtend' | 'usePushNotification'> {
+export interface ProgramView extends View, Omit<Partial<ProgramModel>, 'payment$' | 'cancel$' | 'display$' | 'application$' | 'push$' | 'operator$' | 'passOps$' | 'room$' | 'guide$' | 'seatTime$' | 'isDisplay' | 'useOperatorDisplay' | 'useImage' | 'useFacilityInfo' | 'useAutoExtend' | 'usePushNotification' | 'programStatus'> {
     /** (optional) 프로그램 결제 정보를 보여줌 */
     readonly payment$?: PaymentView;
     /** (optional) 프로그램 취소 정보를 보여줌 */
@@ -34,16 +36,18 @@ export interface ProgramView extends View, Omit<Partial<ProgramModel>, 'payment$
     readonly display$?: DisplayView;
     /** (optional) 프로그램 신청 관리 정보를 보여줌 */
     readonly application$?: ApplicationManagementView;
-    /** (optional) 세분 프로그램 운영 시간 정보를 보여줌 */
-    readonly tile$?: TileView[];
     /** (optional) 게스트룸 프로그램 운영 시간 정보를 보여줌 */
     readonly room$?: RoomView[];
+    /** (optional) 이용권 운영 관리 정보를 보여줌 */
+    readonly passOps$?: PassOpsView;
     /** (optional) 푸쉬 관리 정보를 보여줌 */
     readonly push$?: PushNotificationView;
-    /** (optional) 업체/강사 관리 정보를 보여줌 */
+    /** (optional) 업체/강사 관리 정보를 보여줌
+     * @deprecated
+     */
     readonly operator$?: ProgramOperatorView;
-    /** (optional) 고장 관리 정보를 보여줌 */
-    readonly fault$?: FaultView;
+    /** (optional) 이용안내 정보를 보여줌 */
+    readonly guide$?: GuidelineView;
     /** flag of use display */
     isDisplay?: boolean;
     /** flag of use 이미지 사용 */
@@ -56,11 +60,17 @@ export interface ProgramView extends View, Omit<Partial<ProgramModel>, 'payment$
     usePushNotification?: boolean;
     /** flag of use 강사 프로필 노출 */
     useOperatorDisplay?: boolean;
+    /**
+     * 좌석형 프로그램의 운영시간 정보
+     */
+    SeatTime$?: TimeElementView$;
+    /** 프로그램 상태 */
+    programStatus?: ServiceStatus;
 }
 /**
  * type: `ProgramBody`
  */
-export interface ProgramBody extends Body, Omit<Partial<ProgramView>, 'payment$' | 'cancel$' | 'display$' | 'application$' | 'operator$' | 'fault$'> {
+export interface ProgramBody extends Body, Omit<Partial<ProgramView>, 'payment$' | 'cancel$' | 'display$' | 'application$' | 'operator$' | 'passOps$'> {
     /** (optional) 프로그램 결제 정보를 가짐 */
     payment$?: PaymentBody;
     /** (optional) 프로그램 취소 정보를 가짐 */
@@ -69,9 +79,11 @@ export interface ProgramBody extends Body, Omit<Partial<ProgramView>, 'payment$'
     display$?: DisplayBody;
     /** (optional) 프로그램 신청 관리 정보를 가짐 */
     application$?: ApplicationManagementBody;
-    /** (optional) 고장 관리 정보를 가짐 */
-    fault$?: FaultBody;
-    /** (optional) 업체/강사 관리 정보를 가짐 */
+    /** (optional) 이용권 운영 관리 정보를 가짐 */
+    passOps$?: PassOpsBody;
+    /** (optional) 업체/강사 관리 정보를 가짐
+     * @deprecated
+     */
     operator$?: ProgramOperatorBody;
     /** 구역 정보 -> 유닛 생성을 위해 `ssocio-zacs-api`에 요청하기 위한 정보를 가짐 */
     zacBody?: ZacPostBody;
@@ -123,9 +135,11 @@ export interface PaymentBody extends Body, Partial<PaymentView> {
 /**
  * type: `PolicyView`
  */
-export interface PolicyView extends View, Omit<Partial<PolicyModel>, 'usePenalty'> {
+export interface PolicyView extends View, Omit<Partial<PolicyModel>, 'usePenalty' | 'useOptionRefund'> {
     /** 위약금 사용 여부 flag */
     usePenalty?: boolean;
+    /** 옵션 환불 사용 여부 flag */
+    useOptionRefund?: boolean;
 }
 /**
  * type: `PolicyBody`
@@ -135,9 +149,11 @@ export interface PolicyBody extends Body, Partial<PolicyView> {
 /**
  * type: `CancelView`
  */
-export interface CancelView extends View, Omit<Partial<CancelModel>, 'usePenalty'> {
+export interface CancelView extends View, Omit<Partial<CancelModel>, 'usePenalty' | 'useOptionRefund'> {
     /** 위약금 사용 여부 flag */
     usePenalty?: boolean;
+    /** 옵션 환불 사용 여부 flag */
+    useOptionRefund?: boolean;
 }
 /**
  * type: `CancelBody`
@@ -159,7 +175,7 @@ export interface DisplayBody extends Body, Partial<DisplayView> {
 /**
  * type: `ApplicationManagementView`
  */
-export interface ApplicationManagementView extends View, Omit<Partial<ApplicationManagementModel>, 'useMonthly' | 'useDaily' | 'useEarlyRegister' | 'useAutoExtension' | 'useTimeLimit' | 'useDayOfTheWeekPolicy' | 'useMatchPeriod' | 'useMatchLimit' | 'useSameDayReservation'> {
+export interface ApplicationManagementView extends View, Omit<Partial<ApplicationManagementModel>, 'useMonthly' | 'useDaily' | 'useEarlyRegister' | 'useAutoExtension' | 'useTimeLimit' | 'useDayOfTheWeekPolicy' | 'useSameDayReservation' | 'usePriceDisplay'> {
     /** 월권 신청 사용 여부 flag */
     useMonthly?: boolean;
     /** 일권 신청 사용 여부 flag */
@@ -172,12 +188,10 @@ export interface ApplicationManagementView extends View, Omit<Partial<Applicatio
     useTimeLimit?: boolean;
     /** 요일 정책 사용 여부 flag  */
     useDayOfTheWeekPolicy?: boolean;
-    /** 매칭 상품 이용 기간 사용 여부 flag  */
-    useMatchPeriod?: boolean;
-    /** 매칭 상품 이용 제한 사용 여부 flag  */
-    useMatchLimit?: boolean;
     /** 숙박 관리 당일 예약 허용 여부 flag */
     useSameDayReservation?: boolean;
+    /** 캘린더 금액 노출 여부 */
+    usePriceDisplay?: boolean;
 }
 /**
  * type: `ApplicationManagementBody`
@@ -212,34 +226,6 @@ export interface ProgramOperatorView extends View, Omit<Partial<ProgramOperatorM
  */
 export interface ProgramOperatorBody extends Body, Partial<ProgramOperatorView> {
 }
-/**
- * type: `TileView`
- */
-export interface TileView extends View, Partial<TileModel> {
-}
-/**
- * type: `TileBody`
- */
-export interface TileBody extends Body, Partial<TileView> {
-}
-/**
- * type: `FaultView`
- */
-export interface FaultView extends View, Omit<Partial<FaultModel>, 'time1' | 'time2'> {
-    /** 예약 불가 시작 날짜 (like 2023-02-01) */
-    d1?: string;
-    /** 예약 불가 마감 날짜 (like 2023-02-01) */
-    d2?: string;
-    /** 예약 불가 시작 시간 (like 15:00) */
-    t1?: string;
-    /** 예약 불가 마감 시간 (like 17:00) */
-    t2?: string;
-}
-/**
- * type: `FaultBody`
- */
-export interface FaultBody extends Body, Partial<FaultView> {
-}
 /**
  * type: `StockView`
  */
@@ -280,6 +266,50 @@ export interface LimitView extends View, Omit<Partial<LimitModel>, 'startedAt' |
  */
 export interface LimitBody extends Body, Partial<LimitView> {
 }
+/**
+ * type: `GuidelineView`
+ */
+export interface GuidelineView extends View, Partial<GuidelineModel> {
+}
+/**
+ * type: `GuidelineBody`
+ */
+export interface GuidelineBody extends View, Partial<GuidelineView> {
+}
+/**
+ * type: `PassView`
+ */
+export interface PassView extends View, Omit<Partial<PassModel>, 'useOneDayLimit' | 'useStockDisplay' | 'usageFrom' | 'usageTo' | 'issuedAt' | 'usedAt' | 'canceledAt'> {
+    /**
+     * 1일 예약 제한 사용 여부
+     */
+    useOneDayLimit?: boolean;
+    /**
+     * 재고 노출 사용 여부
+     */
+    useStockDisplay?: boolean;
+    /**
+     * 사용기간 - 시작시각
+     */
+    usageFrom?: string;
+    /**
+     * 사용기간 - 종료시각
+     */
+    usageTo?: string;
+    /** 발급일시 */
+    issuedAt?: string;
+    /** 사용일시 */
+    usedAt?: string;
+    /** 취소일시 */
+    canceledAt?: string;
+}
+/**
+ * type: `PassBody`
+ */
+export interface PassBody extends Body, Partial<PassView> {
+    /** 원본 상품(이용권)의 재고 티켓 ID */
+    originTicketIds?: string[];
+}
 /**
  * type: `TestView`
  * - usually same as post's body.
@@ -299,6 +329,92 @@ export interface TestView extends View, Omit<Partial<TestModel>, 'id' | 'require
  */
 export interface TestBody extends Body, Partial<TestView> {
 }
+/**
+ * Type: `SeatView`
+ */
+export interface SeatView extends View, Omit<Partial<SeatModel>, 'seatStartTime' | 'seatEndTime' | 'assignedAt' | 'canceledAt' | 'isAvailable' | 'isBusinessDay' | 'isHoliday' | 'isSaleDay' | 'isDisableDay' | 'isAssigned' | 'invalid' | 'units'> {
+    /**
+     * 해당 슬롯(좌석) 시작 시각 정보
+     */
+    seatStartTime?: string;
+    /**
+     * 해당 슬롯(좌석) 종료 시각 정보
+     */
+    seatEndTime?: string;
+    /**
+     * 해당 슬롯(좌석) 할당 시각
+     */
+    assignedAt?: string;
+    /**
+     * 해당 슬롯(좌석) 취소 시각
+     */
+    canceledAt?: string;
+    /**
+     * 영업일 여부
+     */
+    isBusinessDay?: boolean;
+    /**
+     * 휴일 여부
+     */
+    isHoliday?: boolean;
+    /**
+     * 할인일 여부
+     */
+    isSaleDay?: boolean;
+    /**
+     * 제한일 여부
+     */
+    isDisableDay?: boolean;
+    /**
+     * 예약 가능 여부
+     */
+    isAvailable?: boolean;
+    /**
+     * 재고 점유 여부
+     */
+    isAssigned?: boolean;
+    /**
+     * invalid
+     */
+    invalid?: boolean;
+    /**
+     * 상품에 묶인 세부 좌석(슬롯) 항목
+     */
+    Units?: SeatView[];
+}
+/**
+ * Type: `SeatBody`
+ */
+export interface SeatBody extends Body, Partial<SeatView> {
+}
+/**
+ * Type: `PassOpsView`
+ */
+export interface PassOpsView extends View, Omit<Partial<PassOpsModel>, 'saleFrom' | 'saleTo' | 'usageFrom' | 'usageTo' | 'usePurchaseLimit' | 'useCountDisplay' | 'programs$'> {
+    /** 판매 시작 시각
+     * format) YYYY-MM-DD HH:MM:SS
+     */
+    saleFrom?: string;
+    /** 판매 종료 시각 */
+    saleTo?: string;
+    /** 사용 시작 시각 */
+    usageFrom?: string;
+    /** 사용 종료 시각 */
+    usageTo?: string;
+    /** 구매 제한 사용 여부
+     * @deprecated
+     */
+    usePurchaseLimit?: boolean;
+    /** 횟수 노출 여부 */
+    useCountDisplay?: boolean;
+    /** 이용권 적용 가능 상품 목록 */
+    readonly AllowedPrograms?: ProgramView[];
+}
+/**
+ * Type: `PassOpsBody`
+ */
+export interface PassOpsBody extends Body, Partial<PassOpsView> {
+}
 /**
  * 프로그램의 `주문시작`을 요청함
  */
@@ -306,25 +422,27 @@ export interface ProgramStartOrderBody extends Body {
     /** program-id */
     id?: string;
     /** type of program */
-    type?: CategoryStereoType;
+    type?: ProgramStereoType;
     /** number of program count */
     count?: number;
     /** list of options to order */
     options?: OrderOption[];
     /** list of agrees to order */
     agreeds?: AgreedOption[];
-    /** list of tiles to order */
-    tiles?: TileBody[];
     /** list of rooms to order */
     rooms?: RoomBody[];
     /** (optional) 기본 주문서에, 상품주문을 추가할때 */
     orderId?: string;
     /** (optional) 주문할 상품을 이용할 사용자ID */
     userId?: string;
-    /** (optional) 좌석 프로그램 예약 시 이용할 타일ID */
-    tileId?: string;
-    /** (optional) 좌속 프로그램 예약 시 이용할 stockId */
+    /** (optional) 좌속 프로그램 예약 시 이용할 stockId
+     * @deprecated
+     */
     stockId?: string;
+    /**
+     * (optional) 결제할 좌석 프로그램 ID 항목
+     */
+    seatGroupIds?: string[];
 }
 /**
  * type: `ZacPostBody`
@@ -350,9 +468,15 @@ export interface CancelProgramBody {
     /** id of cancel-model */
     id?: string;
     /** stereo */
-    stereo?: CategoryStereoType;
-    /** payed-price */
+    stereo?: ProgramStereoType;
+    /**
+     * payed-price
+     * @deprecated
+     * @use CancelProgramBody.paidPrice
+     */
     payedPrice?: number;
+    /** paid-price */
+    paidPrice?: number;
     /** fee amount */
     feeAmount?: number;
     /** penalty amount */
@@ -361,4 +485,161 @@ export interface CancelProgramBody {
     usedAt?: number;
     /** requestedAt (timestamp) */
     requestedAt?: number;
+    /** user-id */
+    userId?: string;
+    /** order-id */
+    orderId?: string;
+    /** 환불 정책 타입*/
+    refundPolicy?: RefundType;
+    /** 환불정책 -> 일할 계산시 운영 일수 */
+    operationCount?: number;
+    /** 환불정책 -> 횟수 계산시 전체 횟수 */
+    totalCount?: number;
+    /** 환불정책 -> 시간기준 수수료 계산시 정보 */
+    baseOnTime?: ComissionRate[];
+    /** 환불정책 -> 날짜기준 수수료 계산시 정보 */
+    baseOnDate?: ComissionRate[];
+    /** 위약금 사용 여부 */
+    usePenalty?: number;
+    /** 위약금 비율 (%) */
+    penaltyRate?: number;
+    /** 환불정책 -> 옵션 환불 정보 */
+    useOptionRefund?: number;
+}
+export interface TimeBlockView extends Omit<Partial<TimeBlock>, 'week'> {
+    /**
+     * 해당 요일의 index */
+    week?: WeekDayType;
 }
+/**
+ * type: `TimeElementView$`
+ */
+export interface TimeElementView$ {
+    /**
+     * key := <WeekDayType>
+     * val := TimeBlockView
+     */
+    [key: string]: TimeBlockView;
+}
+/**
+ * type: `SeatAggrView`
+ * - 프로그램에 매핑된 좌석의 예약 현황을 포함하기 위한 타입
+ */
+export interface SeatAggrView {
+    /** 좌석별 상태
+     * key := <zoneId>,
+     * val := SeatReservationStatus
+     */
+    [key: string]: SeatReservationStatus;
+}
+/**
+ * type: `SeatResverationStatus`
+ */
+export interface SeatReservationStatus {
+    /** 날짜 */
+    date?: string;
+    /** 총 좌석(상품) 갯수 */
+    totalSeat?: number;
+    /** 예약된 좌석 갯수 */
+    reservedCnt?: number;
+    /** 예약가능한 좌석 갯수 */
+    availableSeatCnt?: number;
+    /** 고장등록 좌석 갯수 */
+    disabledCnt?: number;
+    /** 휴일등록 좌석 갯수 */
+    holidayCnt?: number;
+    /** 좌석의 최종 상태 */
+    state?: SeatStateType;
+    /** 구역 관리자 메모 */
+    memo?: string;
+    /** 구역 ID */
+    zoneId?: string;
+    /** 구역 이름 */
+    zoneName?: string;
+    /** 프로그램 ID */
+    programId?: string;
+}
+/**
+ * type: `SeatSalesView`
+ * - 프로그램에 매핑된 좌석의 예약 가능 정보를 보여주기 위함
+ */
+export interface SeatSalesView {
+    /** 좌석별 상품 정보
+     * key := <zoneId>,
+     * val := SeatView
+     */
+    [key: string]: SeatView;
+}
+/**
+ * type: `UserBookingStatusResponse`
+ * 해당 유저의 프로그램 예약 (일자별) 현황 타입
+ */
+export interface UserBookingStatusResponse {
+    /** 날짜 */
+    date?: string;
+    /** 구간검색 (시작 날짜) */
+    from?: string;
+    /** 구간검색 (종료 날짜) */
+    to?: string;
+    /** 설정된 예약 제한 타입 */
+    limitType?: ReserveLimitTargetType;
+    /** 설정된 예약 제한 횟수 */
+    limitCount?: number;
+    /** 해당 유저(세대)가 예약한 횟수 */
+    userBookingCount?: number;
+    /** 예약 가능일 여부 */
+    isSaleDay?: boolean;
+    /** 예약 가능 여부 */
+    isAvailable?: boolean;
+    /** 유저의 아이디 */
+    userId?: string;
+    /** 1일 예약 제한 횟수 */
+    limitDailyCount?: number;
+}
+/**
+ * 상품의 `이용권 사용`을 요청함
+ */
+export interface PassOrderBody {
+    /** 상품의 타입 */
+    prodType?: ProgramStereoType;
+    /** id of the ordered program
+     * - 상품(프로그램)의 ID
+     */
+    prodId?: string;
+    /** user-id */
+    userId?: string;
+    /** 이용권을 적용할 단일 인스턴스의 ID
+     * - 좌석이용권 := seatId
+     * - 프로그램이용권 := programId
+     * - 게스트룸이용권 := roomId
+     */
+    targetId?: string;
+    /** id of order */
+    orderId?: string;
+    /** 이용권 사용할 날짜 */
+    date?: 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;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lemoncloud/ssocio-stacks-api",
-  "version": "0.23.1008",
+  "version": "0.24.106",
   "description": "ssocio stacks management api",
   "types": "dist/view/types.d.ts",
   "scripts": {},