@bootpay/backend-js
Version:
Bootpay Server Side Package for Node.js
56 lines (55 loc) • 2.41 kB
TypeScript
import { BootpayCommerceResource, BootpayCommerceResponse } from '../../commerce-resource';
import { CommerceOrderSubscription, OrderSubscriptionListParams, OrderSubscriptionUpdateParams, OrderSubscriptionPauseParams, OrderSubscriptionResumeParams, OrderSubscriptionTerminationParams, CalcTerminateFeeResponse } from '../types';
export declare class OrderSubscriptionRequestIngModule {
private bootpay;
constructor(bootpay: BootpayCommerceResource);
/**
* 정기구독 일시정지
* @param params 일시정지 파라미터
*/
pause(params: OrderSubscriptionPauseParams): Promise<BootpayCommerceResponse<CommerceOrderSubscription>>;
/**
* 정기구독 재개
* @param params 재개 파라미터
*/
resume(params: OrderSubscriptionResumeParams): Promise<BootpayCommerceResponse<CommerceOrderSubscription>>;
/**
* 해지 수수료 계산
* @param orderSubscriptionId 정기구독 ID (선택)
* @param orderNumber 주문번호 (선택)
*/
calculateTerminationFee(orderSubscriptionId?: string, orderNumber?: string): Promise<BootpayCommerceResponse<CalcTerminateFeeResponse>>;
/**
* 주문번호로 해지 수수료 계산
* @param orderNumber 주문번호
*/
calculateTerminationFeeByOrderNumber(orderNumber: string): Promise<BootpayCommerceResponse<CalcTerminateFeeResponse>>;
/**
* 정기구독 해지
* @param params 해지 파라미터
*/
termination(params: OrderSubscriptionTerminationParams): Promise<BootpayCommerceResponse<CommerceOrderSubscription>>;
}
export declare class OrderSubscriptionModule {
private bootpay;
requestIng: OrderSubscriptionRequestIngModule;
constructor(bootpay: BootpayCommerceResource);
/**
* 정기구독 목록 조회
* @param params 조회 파라미터
*/
list(params?: OrderSubscriptionListParams): Promise<BootpayCommerceResponse<{
items: CommerceOrderSubscription[];
total: number;
}>>;
/**
* 정기구독 상세 조회
* @param orderSubscriptionId 정기구독 ID
*/
detail(orderSubscriptionId: string): Promise<BootpayCommerceResponse<CommerceOrderSubscription>>;
/**
* 정기구독 수정
* @param params 수정 파라미터
*/
update(params: OrderSubscriptionUpdateParams): Promise<BootpayCommerceResponse<CommerceOrderSubscription>>;
}