generate

pokepay · May 23, 2024 · da4e11c · da4e11c
1 parent 7e43816
commit da4e11c
Show file tree

Hide file tree

Showing 31 changed files with 6,699 additions and 4,987 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -196,8 +196,8 @@ try {
 - [ListTransfersV2](./transfer.md#list-transfers-v2): 
 
 ### Check
-- [CreateCheck](./check.md#create-check): チャージQRコードの発行
 - [ListChecks](./check.md#list-checks): チャージQRコード一覧の取得
+- [CreateCheck](./check.md#create-check): チャージQRコードの発行
 - [GetCheck](./check.md#get-check): チャージQRコードの表示
 - [UpdateCheck](./check.md#update-check): チャージQRコードの更新
 - [CreateTopupTransactionWithCheck](./check.md#create-topup-transaction-with-check): チャージQRコードを読み取ることでチャージする
@@ -208,15 +208,16 @@ try {
 - [UpdateBill](./bill.md#update-bill): 支払いQRコードの更新
 
 ### Cashtray
+- [CreateTransactionWithCashtray](./cashtray.md#create-transaction-with-cashtray): CashtrayQRコードを読み取ることで取引する
 - [CreateCashtray](./cashtray.md#create-cashtray): Cashtrayを作る
-- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
 - [CancelCashtray](./cashtray.md#cancel-cashtray): Cashtrayを無効化する
+- [GetCashtray](./cashtray.md#get-cashtray): Cashtrayの情報を取得する
 - [UpdateCashtray](./cashtray.md#update-cashtray): Cashtrayの情報を更新する
 
 ### Customer
+- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
 - [GetAccount](./customer.md#get-account): ウォレット情報を表示する
 - [UpdateAccount](./customer.md#update-account): ウォレット情報を更新する
-- [DeleteAccount](./customer.md#delete-account): ウォレットを退会する
 - [ListAccountBalances](./customer.md#list-account-balances): エンドユーザーの残高内訳を表示する
 - [ListAccountExpiredBalances](./customer.md#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
 - [UpdateCustomerAccount](./customer.md#update-customer-account): エンドユーザーのウォレット情報を更新する
@@ -237,7 +238,6 @@ try {
 - [UpdateShop](./shop.md#update-shop): 店舗情報を更新する
 
 ### User
-- [GetUser](./user.md#get-user): 
 
 ### Account
 - [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
@@ -254,18 +254,19 @@ try {
 ### Event
 - [CreateExternalTransaction](./event.md#create-external-transaction): ポケペイ外部取引を作成する
 - [RefundExternalTransaction](./event.md#refund-external-transaction): ポケペイ外部取引をキャンセルする
+- [GetExternalTransactionByRequestId](./event.md#get-external-transaction-by-request-id): リクエストIDからポケペイ外部取引を取得する
 
 ### Campaign
-- [CreateCampaign](./campaign.md#create-campaign): ポイント付与キャンペーンを作る
 - [ListCampaigns](./campaign.md#list-campaigns): キャンペーン一覧を取得する
+- [CreateCampaign](./campaign.md#create-campaign): ポイント付与キャンペーンを作る
 - [GetCampaign](./campaign.md#get-campaign): キャンペーンを取得する
 - [UpdateCampaign](./campaign.md#update-campaign): ポイント付与キャンペーンを更新する
 
 ### Webhook
-- [CreateWebhook](./webhook.md#create-webhook): webhookの作成
 - [ListWebhooks](./webhook.md#list-webhooks): 作成したWebhookの一覧を返す
-- [UpdateWebhook](./webhook.md#update-webhook): Webhookの更新
+- [CreateWebhook](./webhook.md#create-webhook): webhookの作成
 - [DeleteWebhook](./webhook.md#delete-webhook): Webhookの削除
+- [UpdateWebhook](./webhook.md#update-webhook): Webhookの更新
 
 ### Coupon
 - [ListCoupons](./coupon.md#list-coupons): クーポン一覧の取得
@@ -279,7 +280,7 @@ try {
 - [ActivateUserDevice](./user_device.md#activate-user-device): デバイスの有効化
 
 ### BankPay
-- [CreateBank](./bank_pay.md#create-bank): 銀行口座の登録
 - [ListBanks](./bank_pay.md#list-banks): 登録した銀行の一覧
+- [CreateBank](./bank_pay.md#create-bank): 銀行口座の登録
 - [CreateBankTopupTransaction](./bank_pay.md#create-bank-topup-transaction): 銀行からのチャージ
 
diff --git a/docs/account.md b/docs/account.md
@@ -60,6 +60,7 @@ const response: Response<PaginatedAccountDetails> = await client.send(new ListUs
 を返します
 
 
+
 ---
 
 
@@ -151,6 +152,7 @@ const response: Response<AccountDetail> = await client.send(new CreateUserAccoun
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bank_pay.md b/docs/bank_pay.md
@@ -2,6 +2,53 @@
 BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
 
 
+<a name="list-banks"></a>
+## ListBanks: 登録した銀行の一覧
+登録した銀行を一覧します
+
+```typescript
+const response: Response<Banks> = await client.send(new ListBanks({
+  user_device_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
+  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}));
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`private_money_id`** 
+
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[Banks](./responses.md#banks)
+を返します
+
+
+
+---
+
+
 <a name="create-bank"></a>
 ## CreateBank: 銀行口座の登録
 銀行口座の登録を始めるAPIです。レスポンスに含まれるredirect_urlをユーザーの端末で開き銀行を登録します。
@@ -16,7 +63,7 @@ const response: Response<BankRegisteringInfo> = await client.send(new CreateBank
   private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
   callback_url: "<Deep Link>", // コールバックURL
   kana: "ポケペイタロウ", // ユーザーの氏名 (片仮名で指定)
-  email: "qC15yVJZpc@8KVp.com", // ユーザーのメールアドレス
+  email: "fSCeHqDX4O@ovF1.com", // ユーザーのメールアドレス
   birthdate: "19901142" // 生年月日
 }));
 ```
@@ -98,51 +145,6 @@ const response: Response<BankRegisteringInfo> = await client.send(new CreateBank
 を返します
 
 
----
-
-
-<a name="list-banks"></a>
-## ListBanks: 登録した銀行の一覧
-登録した銀行を一覧します
-
-```typescript
-const response: Response<Banks> = await client.send(new ListBanks({
-  user_device_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
-  private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
-}));
-```
-
-
-
-### Parameters
-**`user_device_id`** 
-
-
-
-```json
-{
-  "type": "string",
-  "format": "uuid"
-}
-```
-
-**`private_money_id`** 
-
-
-
-```json
-{
-  "type": "string",
-  "format": "uuid"
-}
-```
-
-
-
-成功したときは
-[Banks](./responses.md#banks)
-を返します
-
 
 ---
 
@@ -155,7 +157,7 @@ const response: Response<Banks> = await client.send(new ListBanks({
 const response: Response<TransactionDetail> = await client.send(new CreateBankTopupTransaction({
   user_device_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // デバイスID
   private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
-  amount: 7742, // チャージ金額
+  amount: 8157, // チャージ金額
   bank_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 銀行ID
   request_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // リクエストID
 }));
@@ -226,6 +228,7 @@ const response: Response<TransactionDetail> = await client.send(new CreateBankTo
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bill.md b/docs/bill.md
@@ -7,18 +7,18 @@
 
 ```typescript
 const response: Response<PaginatedBills> = await client.send(new ListBills({
-  page: 8308, // ページ番号
-  per_page: 5622, // 1ページの表示数
-  bill_id: "laKx", // 支払いQRコードのID
+  page: 546, // ページ番号
+  per_page: 6224, // 1ページの表示数
+  bill_id: "0zGq4P", // 支払いQRコードのID
   private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
-  organization_code: "CMf-9Tbr-uA-3dv2K1u-t2aU848H--", // 組織コード
+  organization_code: "x---uV-ld6at5-L7-g-FnGpUst", // 組織コード
   description: "test bill", // 取引説明文
-  created_from: "2020-01-14T03:21:13.000000Z", // 作成日時(起点)
-  created_to: "2020-09-03T11:53:51.000000Z", // 作成日時(終点)
+  created_from: "2023-09-11T07:24:00.000000Z", // 作成日時(起点)
+  created_to: "2020-07-14T19:40:44.000000Z", // 作成日時(終点)
   shop_name: "bill test shop1", // 店舗名
   shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 店舗ID
-  lower_limit_amount: 3745, // 金額の範囲によるフィルタ(下限)
-  upper_limit_amount: 6172, // 金額の範囲によるフィルタ(上限)
+  lower_limit_amount: 7712, // 金額の範囲によるフィルタ(下限)
+  upper_limit_amount: 3564, // 金額の範囲によるフィルタ(上限)
   is_disabled: true // 支払いQRコードが無効化されているかどうか
 }));
 ```
@@ -193,6 +193,12 @@ const response: Response<PaginatedBills> = await client.send(new ListBills({
 [PaginatedBills](./responses.md#paginated-bills)
 を返します
 
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+
+
 
 ---
 
@@ -205,7 +211,7 @@ const response: Response<PaginatedBills> = await client.send(new ListBills({
 const response: Response<Bill> = await client.send(new CreateBill({
   private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いマネーのマネーID
   shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払い先(受け取り人)の店舗ID
-  amount: 6991.0, // 支払い額
+  amount: 2526.0, // 支払い額
   description: "test bill" // 説明文(アプリ上で取引の説明文として表示される)
 }));
 ```
@@ -265,6 +271,18 @@ const response: Response<Bill> = await client.send(new CreateBill({
 [Bill](./responses.md#bill)
 を返します
 
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|shop_account_not_found||The shop account is not found|
+|422|private_money_not_found||Private money not found|
+|422|shop_user_not_found|店舗が見つかりません|The shop user is not found|
+|422|account_closed|アカウントは退会しています|The account is closed|
+|422|account_pre_closed|アカウントは退会準備中です|The account is pre-closed|
+|422|account_suspended|アカウントは停止されています|The account is suspended|
+
+
 
 ---
 
@@ -276,9 +294,9 @@ const response: Response<Bill> = await client.send(new CreateBill({
 ```typescript
 const response: Response<Bill> = await client.send(new UpdateBill({
   bill_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 支払いQRコードのID
-  amount: 3919.0, // 支払い額
+  amount: 8673.0, // 支払い額
   description: "test bill", // 説明文
-  is_disabled: true // 無効化されているかどうか
+  is_disabled: false // 無効化されているかどうか
 }));
 ```
 
@@ -340,6 +358,7 @@ const response: Response<Bill> = await client.send(new UpdateBill({
 を返します
 
 
+
 ---
 
 

diff --git a/docs/bulk.md b/docs/bulk.md
@@ -6,10 +6,10 @@ CSVファイルから一括取引をします。
 
 ```typescript
 const response: Response<BulkTransaction> = await client.send(new BulkCreateTransaction({
-  name: "skU0m8hSr1melepO9LnwIsUc", // 一括取引タスク名
-  content: "mvb4", // 取引する情報のCSV
-  request_id: "GOUqCz9cGDIhlPt52zP7YS2DWusWLcKpd2P3", // リクエストID
-  description: "35Nv6jpCTg7cI", // 一括取引の説明
+  name: "kU0m8hSr1melepO9LnwI", // 一括取引タスク名
+  content: "s", // 取引する情報のCSV
+  request_id: "UcSmvb4GOUqCz9cGDIhlPt52zP7YS2DWusWL", // リクエストID
+  description: "Kpd2P335Nv6jpCTg7cImjgcPmkAEumRe3ajMg8VGC0KZL7VMaMEGv2NsNRGCHkqW6b190Xf2yHeAyBqIIySMiYLD3kq3Znz8pepf", // 一括取引の説明
   private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // マネーID
 }));
 ```
@@ -104,6 +104,16 @@ const response: Response<BulkTransaction> = await client.send(new BulkCreateTran
 [BulkTransaction](./responses.md#bulk-transaction)
 を返します
 
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|403|organization_not_issuer|発行体以外に許可されていない操作です|Unpermitted operation except for issuer organizations.|
+|409|NULL|NULL|NULL|
+|422|private_money_not_found||Private money not found|
+|422|bulk_transaction_invalid_csv_format|入力されたCSVデータに誤りがあります|Invalid csv format|
+
+
 
 ---
-Original file line number
+Diff line change
@@ Expand Up @@
     を返します
     ---
@@ Expand Down Expand Up @@
     を返します
     ---
@@ Expand Down @@