bootpay-backend 2.1.2__tar.gz → 2.2.0__tar.gz

{bootpay_backend-2.1.2/bootpay_backend.egg-info → bootpay_backend-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
-Name: bootpay-backend
-Version: 2.1.2
+Name: bootpay_backend
+Version: 2.2.0
 Summary: bootpay server side plugin for python
 Home-page: https://github.com/bootpay/backend-python/tree/2-x-development
 Author: bootpay <bootpay.co.kr@gmail.com>
@@ -37,41 +37,35 @@ Python 언어로 작성된 어플리케이션, 프레임워크 등에서 사용
 * PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
 * 결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)
 
-
-## 기능   
-1. (부트페이 통신을 위한) 토큰 발급
-2. 결제 단건 조회 
-3. 결제 취소 (전액 취소 / 부분 취소)
-4. 신용카드 자동결제 (빌링결제)
-
-   4-1. 빌링키 발급
-
-   4-2. 발급된 빌링키로 결제 승인 요청
-
-   4-3. 발급된 빌링키로 결제 예약 요청
-
-   4-4. 발급된 빌링키로 결제 예약 - 취소 요청
-
-   4-5. 빌링키 삭제
-
-   4-6. 빌링키 조회
-
-5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
-6. 서버 승인 요청
-7. 본인 인증 결과 조회
-8. (에스크로 이용시) PG사로 배송정보 보내기
-9. 현금영수증 발행 
-   
-   9-1. 현금영수증 발행 
-
-   9-2. 현금영수증 발행 취소 
-
-   9-3. (별건) 현금영수증 발행
-
-   9-4. (별건) 현금영수증 발행 취소 
-## pypi로 설치하기   
-
-
+## 목차 
+- [사용하기](#사용하기)
+   - [1. 토큰 발급](#1-토큰-발급)
+   - [2. 결제 단건 조회](#2-결제-단건-조회)
+   - [3. 결제 취소 (전액 취소 / 부분 취소)](#3-결제-취소-전액-취소--부분-취소)
+   - [4. 자동/빌링/정기 결제](#4-자동빌링정기-결제)
+      - [4-1. 카드 빌링키 발급](#4-1-카드-빌링키-발급)
+      - [4-2. 계좌 빌링키 발급](#4-2-계좌-빌링키-발급)
+      - [4-3. 결제 요청하기](#4-3-결제-요청하기)
+      - [4-4. 결제 예약하기](#4-4-결제-예약하기)
+      - [4-5. 예약 조회하기](#4-5-예약-조회하기)
+      - [4-6. 예약 취소하기](#4-6-예약-취소하기)
+      - [4-7. 빌링키 삭제하기](#4-7-빌링키-삭제하기)
+      - [4-8. 빌링키 조회하기](#4-8-빌링키-조회하기)
+   - [5. 회원 토큰 발급요청](#5-회원-토큰-발급요청)
+   - [6. 서버 승인 요청](#6-서버-승인-요청)
+   - [7. 본인 인증 결과 조회](#7-본인-인증-결과-조회)
+   - [8. 에스크로 이용시 PG사로 배송정보 보내기](#8-에스크로-이용시-pg사로-배송정보-보내기)
+   - [9-1. 현금영수증 발행하기](#9-1-현금영수증-발행하기)
+   - [9-2. 현금영수증 발행 취소](#9-2-현금영수증-발행-취소)
+   - [9-3. 별건 현금영수증 발행](#9-3-별건-현금영수증-발행)
+   - [9-4. 별건 현금영수증 발행 취소](#9-4-별건-현금영수증-발행-취소)
+- [Example 프로젝트](#example-프로젝트)
+- [Documentation](#documentation)
+- [기술문의](#기술문의)
+- [License](#license)
+
+
+## pypi로 설치하기
 ```
 pip install bootpay-backend
 ```
@@ -91,7 +85,7 @@ if 'error_code' not in token:
 ```
 
 
-## 1. (부트페이 통신을 위한) 토큰 발급
+## 1. 토큰 발급
 
 부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
 발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
@@ -137,7 +131,9 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-1. 빌링키 발급 
+## 4. 자동/빌링/정기 결제
+
+## 4-1. 카드 빌링키 발급
 REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 
 발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
 * 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. 
@@ -158,7 +154,34 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-2. 발급된 빌링키로 결제 승인 요청
+
+## 4-2. 계좌 빌링키 발급
+REST API 방식으로 고객의 계좌 정보를 전달하여, PG사에게 빌링키 발급을 요청합니다. 요청 후 빌링키가 바로 발급되진 않고, 출금동의 확인 절차까지 진행해야 빌링키가 발급됩니다.
+먼저 빌링키를 요청합니다.
+```python 
+response = bootpay.request_subscribe_automatic_transfer_billing_key(
+        pg="나이스페이",
+        order_name='테스트결제',
+        subscription_id=str(time.time()),
+        price=1000,
+        username='홍길동',
+        bank_name='국민',
+        bank_account='67560123412342472',
+        identity_no='901014',
+        cash_receipt_identity_no='01012341234',
+        phone='01012341234'
+    )
+```
+
+이후 빌링키 발급 요청시 응답받은 receipt_id로, 출금 동의 확인을 요청합니다.
+```python
+response = bootpay.publish_automatic_transfer_billing_key(
+    receipt_id="66542d4be86c1eedf6b17965",
+)
+```
+
+
+## 4-3. 결제 요청하기
 발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
 
 ```python 
@@ -177,7 +200,7 @@ if 'error_code' not in response:
     # 요청 성공 
     print(response)
 ``` 
-## 4-3. 발급된 빌링키로 결제 예약 요청
+## 4-4. 결제 예약하기
 원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 10건)
 ```python 
 response = bootpay.subscribe_payment_reserve(
@@ -198,8 +221,15 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-4. 발급된 빌링키로 결제 예약 - 취소 요청
-빌링키로 예약된 결제건을 취소합니다.
+## 4-5. 예약 조회하기
+예약시 응답받은 reserveId로 예약된 건을 조회합니다.
+```python
+response = bootpay.subscribe_payment_reserve_lookup('6490149ca575b40024f0b70d')
+print(response)
+```
+
+## 4-6. 예약 취소하기
+예약시 응답받은 reserveId로 예약된 건을 취소합니다.
 ```python
 result = bootpay.cancel_subscribe_reserve(
         '612debc70d681b0039e6133d'
@@ -209,8 +239,8 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-5. 빌링키 삭제 
-발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.
+## 4-7. 빌링키 삭제하기
+발급된 빌링키를 삭제합니다. 삭제하더라도 예약된 결제건은 취소되지 않습니다. 예약된 결제건 취소를 원하시면 예약 취소하기를 요청하셔야 합니다. 
 ```python 
 response = bootpay.destroy_billing_key(
         billing_key='62b2c3cfd01c7e001cc20a85',
@@ -220,19 +250,24 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-6. 빌링키 조회
-(빌링키 발급 완료시 리턴받았던 receipt_id에 한정) 어떤 빌링키였는지 조회합니다. 
+## 4-8. 빌링키 조회하기
+클라이언트에서 빌링키 발급시, 보안상 클라이언트 이벤트에 빌링키를 전달해주지 않습니다. 그러므로 이 API를 통해 조회해야 합니다.
+다음은 빌링키 발급 요청했던 receiptId 로 빌링키를 조회합니다.
 ```python 
 response = bootpay.lookup_subscribe_billing_key('62b2c3c2d01c7e001bc20b10')
 if 'error_code' not in response:
     # 요청 성공 
     print(response)
 ```
+아래는 billingKey로 조회합니다.
+```python 
+response = bootpay.lookup_billing_key('66542dfb4d18d5fc7b43e1b6')
+print(response)
+```
 
-
-## 5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
-(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다.
-이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
+## 5. 회원 토큰 발급요청
+ㅇㅇ페이 사용을 위해 가맹점 회원의 토큰을 발급합니다. 가맹점은 회원의 고유번호를 관리해야합니다.
+이 토큰값을 기반으로 클라이언트에서 결제요청(payload.user_token) 하시면 되겠습니다.
 ```python 
 result = bootpay.request_user_token({
         'user_id': '12341-234',
@@ -370,7 +405,7 @@ if 'error_code' not in token:
 
 ## Documentation
 
-[부트페이 개발매뉴얼](https://docs.bootpay.co.kr/next/)을 참조해주세요
+[부트페이 개발매뉴얼](https://developer.bootpay.co.kr/)을 참조해주세요
 
 ## 기술문의
 

{bootpay_backend-2.1.2 → bootpay_backend-2.2.0}/README.md

@@ -7,41 +7,35 @@ Python 언어로 작성된 어플리케이션, 프레임워크 등에서 사용
 * PG 결제창 연동은 클라이언트 라이브러리에서 수행됩니다. (Javascript, Android, iOS, React Native, Flutter 등)
 * 결제 검증 및 취소, 빌링키 발급, 본인인증 등의 수행은 서버사이드에서 진행됩니다. (Java, PHP, Python, Ruby, Node.js, Go, ASP.NET 등)
 
-
-## 기능   
-1. (부트페이 통신을 위한) 토큰 발급
-2. 결제 단건 조회 
-3. 결제 취소 (전액 취소 / 부분 취소)
-4. 신용카드 자동결제 (빌링결제)
-
-   4-1. 빌링키 발급
-
-   4-2. 발급된 빌링키로 결제 승인 요청
-
-   4-3. 발급된 빌링키로 결제 예약 요청
-
-   4-4. 발급된 빌링키로 결제 예약 - 취소 요청
-
-   4-5. 빌링키 삭제
-
-   4-6. 빌링키 조회
-
-5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
-6. 서버 승인 요청
-7. 본인 인증 결과 조회
-8. (에스크로 이용시) PG사로 배송정보 보내기
-9. 현금영수증 발행 
-   
-   9-1. 현금영수증 발행 
-
-   9-2. 현금영수증 발행 취소 
-
-   9-3. (별건) 현금영수증 발행
-
-   9-4. (별건) 현금영수증 발행 취소 
-## pypi로 설치하기   
-
-
+## 목차 
+- [사용하기](#사용하기)
+   - [1. 토큰 발급](#1-토큰-발급)
+   - [2. 결제 단건 조회](#2-결제-단건-조회)
+   - [3. 결제 취소 (전액 취소 / 부분 취소)](#3-결제-취소-전액-취소--부분-취소)
+   - [4. 자동/빌링/정기 결제](#4-자동빌링정기-결제)
+      - [4-1. 카드 빌링키 발급](#4-1-카드-빌링키-발급)
+      - [4-2. 계좌 빌링키 발급](#4-2-계좌-빌링키-발급)
+      - [4-3. 결제 요청하기](#4-3-결제-요청하기)
+      - [4-4. 결제 예약하기](#4-4-결제-예약하기)
+      - [4-5. 예약 조회하기](#4-5-예약-조회하기)
+      - [4-6. 예약 취소하기](#4-6-예약-취소하기)
+      - [4-7. 빌링키 삭제하기](#4-7-빌링키-삭제하기)
+      - [4-8. 빌링키 조회하기](#4-8-빌링키-조회하기)
+   - [5. 회원 토큰 발급요청](#5-회원-토큰-발급요청)
+   - [6. 서버 승인 요청](#6-서버-승인-요청)
+   - [7. 본인 인증 결과 조회](#7-본인-인증-결과-조회)
+   - [8. 에스크로 이용시 PG사로 배송정보 보내기](#8-에스크로-이용시-pg사로-배송정보-보내기)
+   - [9-1. 현금영수증 발행하기](#9-1-현금영수증-발행하기)
+   - [9-2. 현금영수증 발행 취소](#9-2-현금영수증-발행-취소)
+   - [9-3. 별건 현금영수증 발행](#9-3-별건-현금영수증-발행)
+   - [9-4. 별건 현금영수증 발행 취소](#9-4-별건-현금영수증-발행-취소)
+- [Example 프로젝트](#example-프로젝트)
+- [Documentation](#documentation)
+- [기술문의](#기술문의)
+- [License](#license)
+
+
+## pypi로 설치하기
 ```
 pip install bootpay-backend
 ```
@@ -61,7 +55,7 @@ if 'error_code' not in token:
 ```
 
 
-## 1. (부트페이 통신을 위한) 토큰 발급
+## 1. 토큰 발급
 
 부트페이와 서버간 통신을 하기 위해서는 부트페이 서버로부터 토큰을 발급받아야 합니다.  
 발급된 토큰은 30분간 유효하며, 최초 발급일로부터 30분이 지날 경우 토큰 발급 함수를 재호출 해주셔야 합니다.
@@ -107,7 +101,9 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-1. 빌링키 발급 
+## 4. 자동/빌링/정기 결제
+
+## 4-1. 카드 빌링키 발급
 REST API 방식으로 고객으로부터 카드 정보를 전달하여, PG사에게 빌링키를 발급받을 수 있습니다. 
 발급받은 빌링키를 저장하고 있다가, 원하는 시점, 원하는 금액에 결제 승인 요청하여 좀 더 자유로운 결제시나리오에 적용이 가능합니다.
 * 비인증 정기결제(REST API) 방식을 지원하는 PG사만 사용 가능합니다. 
@@ -128,7 +124,34 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-2. 발급된 빌링키로 결제 승인 요청
+
+## 4-2. 계좌 빌링키 발급
+REST API 방식으로 고객의 계좌 정보를 전달하여, PG사에게 빌링키 발급을 요청합니다. 요청 후 빌링키가 바로 발급되진 않고, 출금동의 확인 절차까지 진행해야 빌링키가 발급됩니다.
+먼저 빌링키를 요청합니다.
+```python 
+response = bootpay.request_subscribe_automatic_transfer_billing_key(
+        pg="나이스페이",
+        order_name='테스트결제',
+        subscription_id=str(time.time()),
+        price=1000,
+        username='홍길동',
+        bank_name='국민',
+        bank_account='67560123412342472',
+        identity_no='901014',
+        cash_receipt_identity_no='01012341234',
+        phone='01012341234'
+    )
+```
+
+이후 빌링키 발급 요청시 응답받은 receipt_id로, 출금 동의 확인을 요청합니다.
+```python
+response = bootpay.publish_automatic_transfer_billing_key(
+    receipt_id="66542d4be86c1eedf6b17965",
+)
+```
+
+
+## 4-3. 결제 요청하기
 발급된 빌링키로 원하는 시점에 원하는 금액으로 결제 승인 요청을 할 수 있습니다. 잔액이 부족하거나 도난 카드 등의 특별한 건이 아니면 PG사에서 결제를 바로 승인합니다.
 
 ```python 
@@ -147,7 +170,7 @@ if 'error_code' not in response:
     # 요청 성공 
     print(response)
 ``` 
-## 4-3. 발급된 빌링키로 결제 예약 요청
+## 4-4. 결제 예약하기
 원하는 시점에 4-1로 결제 승인 요청을 보내도 되지만, 빌링키 발급 이후에 바로 결제 예약 할 수 있습니다. (빌링키당 최대 10건)
 ```python 
 response = bootpay.subscribe_payment_reserve(
@@ -168,8 +191,15 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-4. 발급된 빌링키로 결제 예약 - 취소 요청
-빌링키로 예약된 결제건을 취소합니다.
+## 4-5. 예약 조회하기
+예약시 응답받은 reserveId로 예약된 건을 조회합니다.
+```python
+response = bootpay.subscribe_payment_reserve_lookup('6490149ca575b40024f0b70d')
+print(response)
+```
+
+## 4-6. 예약 취소하기
+예약시 응답받은 reserveId로 예약된 건을 취소합니다.
 ```python
 result = bootpay.cancel_subscribe_reserve(
         '612debc70d681b0039e6133d'
@@ -179,8 +209,8 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-5. 빌링키 삭제 
-발급된 빌링키로 더 이상 사용되지 않도록, 삭제 요청합니다.
+## 4-7. 빌링키 삭제하기
+발급된 빌링키를 삭제합니다. 삭제하더라도 예약된 결제건은 취소되지 않습니다. 예약된 결제건 취소를 원하시면 예약 취소하기를 요청하셔야 합니다. 
 ```python 
 response = bootpay.destroy_billing_key(
         billing_key='62b2c3cfd01c7e001cc20a85',
@@ -190,19 +220,24 @@ if 'error_code' not in response:
     print(response)
 ```
 
-## 4-6. 빌링키 조회
-(빌링키 발급 완료시 리턴받았던 receipt_id에 한정) 어떤 빌링키였는지 조회합니다. 
+## 4-8. 빌링키 조회하기
+클라이언트에서 빌링키 발급시, 보안상 클라이언트 이벤트에 빌링키를 전달해주지 않습니다. 그러므로 이 API를 통해 조회해야 합니다.
+다음은 빌링키 발급 요청했던 receiptId 로 빌링키를 조회합니다.
 ```python 
 response = bootpay.lookup_subscribe_billing_key('62b2c3c2d01c7e001bc20b10')
 if 'error_code' not in response:
     # 요청 성공 
     print(response)
 ```
+아래는 billingKey로 조회합니다.
+```python 
+response = bootpay.lookup_billing_key('66542dfb4d18d5fc7b43e1b6')
+print(response)
+```
 
-
-## 5. (생체인증, 비밀번호 결제를 위한) 구매자 토큰 발급
-(부트페이 단독) 부트페이에서 제공하는 간편결제창, 생체인증 기반의 결제 사용을 위해서는 개발사에서 회원 고유번호를 관리해야하며, 해당 회원에 대한 사용자 토큰을 발급합니다.
-이 토큰값을 기반으로 클라이언트에서 결제요청 하시면 되겠습니다.
+## 5. 회원 토큰 발급요청
+ㅇㅇ페이 사용을 위해 가맹점 회원의 토큰을 발급합니다. 가맹점은 회원의 고유번호를 관리해야합니다.
+이 토큰값을 기반으로 클라이언트에서 결제요청(payload.user_token) 하시면 되겠습니다.
 ```python 
 result = bootpay.request_user_token({
         'user_id': '12341-234',
@@ -340,7 +375,7 @@ if 'error_code' not in token:
 
 ## Documentation
 
-[부트페이 개발매뉴얼](https://docs.bootpay.co.kr/next/)을 참조해주세요
+[부트페이 개발매뉴얼](https://developer.bootpay.co.kr/)을 참조해주세요
 
 ## 기술문의
 

bootpay_backend-2.2.0/bootpay_backend/__init__.py

@@ -0,0 +1,4 @@
+from .rest_client import BootpayBackend
+from .commerce import BootpayCommerce
+
+__all__ = ['BootpayBackend', 'BootpayCommerce']

bootpay_backend-2.2.0/bootpay_backend/commerce/__init__.py

@@ -0,0 +1,245 @@
+# Commerce API
+from .commerce_resource import BootpayCommerceResource
+from .modules import (
+    UserModule,
+    UserGroupModule,
+    ProductModule,
+    InvoiceModule,
+    OrderModule,
+    OrderCancelModule,
+    OrderSubscriptionModule,
+    OrderSubscriptionBillModule,
+    OrderSubscriptionAdjustmentModule
+)
+from .types import *
+
+
+class BootpayCommerce(BootpayCommerceResource):
+    """
+    Bootpay Commerce API 클라이언트
+
+    사용 예시:
+    ```python
+    from bootpay_backend.commerce import BootpayCommerce
+
+    commerce = BootpayCommerce(
+        client_key='your_client_key',
+        secret_key='your_secret_key',
+        mode='production'  # 'development', 'stage', 'production'
+    )
+
+    # 액세스 토큰 발급
+    token_response = commerce.get_access_token()
+
+    # 사용자 목록 조회
+    users = commerce.user.list({'page': 1, 'limit': 10})
+
+    # Role 설정 (메서드 체이닝 지원)
+    commerce.as_manager()
+    products = commerce.product.list()
+    ```
+    """
+
+    def __init__(self, client_key: str = None, secret_key: str = None, mode: str = 'production'):
+        """
+        BootpayCommerce 초기화
+
+        :param client_key: Commerce API 클라이언트 키
+        :param secret_key: Commerce API 시크릿 키
+        :param mode: 환경 ('development', 'stage', 'production')
+        """
+        super().__init__()
+        if client_key and secret_key:
+            self.set_configuration(client_key, secret_key, mode)
+        self._init_modules()
+
+    def _init_modules(self):
+        """모듈 초기화"""
+        self.user = UserModule(self)
+        self.user_group = UserGroupModule(self)
+        self.product = ProductModule(self)
+        self.invoice = InvoiceModule(self)
+        self.order = OrderModule(self)
+        self.order_cancel = OrderCancelModule(self)
+        self.order_subscription = OrderSubscriptionModule(self)
+        self.order_subscription_bill = OrderSubscriptionBillModule(self)
+        self.order_subscription_adjustment = OrderSubscriptionAdjustmentModule(self)
+
+    def get_access_token(self):
+        """
+        액세스 토큰 발급
+        client_key/secret_key로 인증
+
+        :return: {'access_token': str, 'expired_at': str}
+        """
+        response = self.post_with_basic_auth('request/token', {
+            'client_key': self.client_key,
+            'secret_key': self.secret_key
+        })
+
+        if response.get('access_token'):
+            self.set_token(response['access_token'])
+
+        return response
+
+    def with_token(self):
+        """
+        토큰을 발급받아 설정합니다. (메서드 체이닝 지원)
+
+        :return: self
+        """
+        self.get_access_token()
+        return self
+
+    def get_current_token(self) -> str:
+        """
+        현재 설정된 토큰을 반환합니다.
+
+        :return: 현재 토큰
+        """
+        return self.get_token()
+
+    def has_token(self) -> bool:
+        """
+        토큰이 설정되어 있는지 확인합니다.
+
+        :return: 토큰 설정 여부
+        """
+        token = self.get_token()
+        return token is not None and token != ''
+
+    def with_role(self, role: str):
+        """
+        현재 role을 설정합니다. (메서드 체이닝 지원)
+
+        :param role: 설정할 role
+        :return: self
+        """
+        self.set_role(role)
+        return self
+
+    def as_user(self):
+        """
+        일반 사용자 role로 설정합니다.
+
+        :return: self
+        """
+        return self.with_role('user')
+
+    def as_manager(self):
+        """
+        매니저 role로 설정합니다.
+
+        :return: self
+        """
+        return self.with_role('manager')
+
+    def as_partner(self):
+        """
+        파트너 role로 설정합니다.
+
+        :return: self
+        """
+        return self.with_role('partner')
+
+    def as_vendor(self):
+        """
+        벤더 role로 설정합니다.
+
+        :return: self
+        """
+        return self.with_role('vendor')
+
+    def as_supervisor(self):
+        """
+        슈퍼바이저 role로 설정합니다.
+
+        :return: self
+        """
+        return self.with_role('supervisor')
+
+    def get_current_role(self) -> str:
+        """
+        현재 role을 반환합니다.
+
+        :return: 현재 role
+        """
+        return self.get_role()
+
+    def clear_role(self):
+        """
+        role을 기본값(user)으로 초기화합니다.
+
+        :return: self
+        """
+        self.set_role('user')
+        return self
+
+
+__all__ = [
+    'BootpayCommerce',
+    'BootpayCommerceResource',
+    'UserModule',
+    'UserGroupModule',
+    'ProductModule',
+    'InvoiceModule',
+    'OrderModule',
+    'OrderCancelModule',
+    'OrderSubscriptionModule',
+    'OrderSubscriptionBillModule',
+    'OrderSubscriptionAdjustmentModule',
+    # Types
+    'ListParams',
+    'CommerceAddress',
+    'CommerceAddressInstruction',
+    'CommerceUserGroupRef',
+    'CommerceUser',
+    'UserListParams',
+    'UserTokenResponse',
+    'UserLoginResponse',
+    'CommerceUserGroup',
+    'CORPORATE_TYPE_INDIVIDUAL',
+    'CORPORATE_TYPE_CORPORATE',
+    'UserGroupListParams',
+    'UserGroupLimitParams',
+    'UserGroupAggregateTransactionParams',
+    'CommerceProductOption',
+    'CommerceSubscriptionSetting',
+    'CommerceProduct',
+    'ProductListParams',
+    'ProductStatusParams',
+    'INVOICE_SEND_TYPE_SMS',
+    'INVOICE_SEND_TYPE_KAKAO',
+    'INVOICE_SEND_TYPE_EMAIL',
+    'INVOICE_SEND_TYPE_PUSH',
+    'CommerceInvoiceItem',
+    'CommerceInvoice',
+    'InvoiceListParams',
+    'InvoiceCreateParams',
+    'SUBSCRIPTION_BILLING_TYPE_NONE',
+    'SUBSCRIPTION_BILLING_TYPE_EACH',
+    'SUBSCRIPTION_BILLING_TYPE_GROUP',
+    'CommerceChosenProductOption',
+    'CommerceOrderCancellationRequestHistory',
+    'CommerceOrder',
+    'OrderListParams',
+    'OrderCancelListParams',
+    'CancelProduct',
+    'CancelOrderSubscriptionBill',
+    'RequestCancelParameter',
+    'OrderCancelParams',
+    'OrderCancelActionParams',
+    'CommerceOrderCancelRequestHistory',
+    'CommerceOrderSubscription',
+    'OrderSubscriptionListParams',
+    'OrderSubscriptionUpdateParams',
+    'OrderSubscriptionPauseParams',
+    'OrderSubscriptionResumeParams',
+    'OrderSubscriptionTerminationParams',
+    'CalcTerminateFeeResponse',
+    'CommerceOrderSubscriptionBill',
+    'OrderSubscriptionBillListParams',
+    'SUBSCRIPTION_ADJUSTMENT_TYPE_PERIOD_DISCOUNT',
+    'CommerceOrderSubscriptionAdjustment',
+    'OrderSubscriptionAdjustmentUpdateParams',
+]