@bootpay/backend-js
Version:
Bootpay Server Side Package for Node.js
52 lines (51 loc) • 1.92 kB
TypeScript
import { BootpayCommerceResource, BootpayCommerceResponse } from '../../commerce-resource';
import { CommerceUserGroup, UserGroupListParams, UserGroupLimitParams, UserGroupAggregateTransactionParams } from '../types';
export declare class UserGroupModule {
private bootpay;
constructor(bootpay: BootpayCommerceResource);
/**
* 사용자 그룹 생성
* @param userGroup 그룹 정보
*/
create(userGroup: CommerceUserGroup): Promise<BootpayCommerceResponse<CommerceUserGroup>>;
/**
* 사용자 그룹 목록 조회
* @param params 조회 파라미터
*/
list(params?: UserGroupListParams): Promise<BootpayCommerceResponse<{
items: CommerceUserGroup[];
total: number;
}>>;
/**
* 사용자 그룹 상세 조회
* @param userGroupId 그룹 ID
*/
detail(userGroupId: string): Promise<BootpayCommerceResponse<CommerceUserGroup>>;
/**
* 사용자 그룹 수정
* @param userGroup 그룹 정보
*/
update(userGroup: CommerceUserGroup): Promise<BootpayCommerceResponse<CommerceUserGroup>>;
/**
* 그룹에 사용자 추가
* @param userGroupId 그룹 ID
* @param userId 사용자 ID
*/
userCreate(userGroupId: string, userId: string): Promise<BootpayCommerceResponse<null>>;
/**
* 그룹에서 사용자 제거
* @param userGroupId 그룹 ID
* @param userId 사용자 ID
*/
userDelete(userGroupId: string, userId: string): Promise<BootpayCommerceResponse<null>>;
/**
* 그룹 제한 설정
* @param params 제한 설정 파라미터
*/
limit(params: UserGroupLimitParams): Promise<BootpayCommerceResponse<CommerceUserGroup>>;
/**
* 그룹 거래 집계 조회
* @param params 집계 파라미터
*/
aggregateTransaction(params: UserGroupAggregateTransactionParams): Promise<BootpayCommerceResponse<any>>;
}