pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

data/docs/bill.md

@@ -0,0 +1,365 @@
+# Bill
+支払いQRコード
+
+<a name="list-bills"></a>
+## ListBills: 支払いQRコード一覧を表示する
+支払いQRコード一覧を表示します。
+
+```RUBY
+response = $client.send(Pokepay::Request::ListBills.new(
+                          page: 6224,                                           # ページ番号
+                          per_page: 8406,                                       # 1ページの表示数
+                          bill_id: "0zGq4PpZBc",                                # 支払いQRコードのID
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", # マネーID
+                          organization_code: "V-ld6at5-L7-g-FnGpUsttbam6-RlUA", # 組織コード
+                          description: "test bill",                             # 取引説明文
+                          created_from: "2023-04-03T07:59:20.000000Z",          # 作成日時(起点)
+                          created_to: "2020-07-16T05:37:27.000000Z",            # 作成日時(終点)
+                          shop_name: "bill test shop1",                         # 店舗名
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      # 店舗ID
+                          lower_limit_amount: 2765,                             # 金額の範囲によるフィルタ(下限)
+                          upper_limit_amount: 5851,                             # 金額の範囲によるフィルタ(上限)
+                          is_disabled: true                                     # 支払いQRコードが無効化されているかどうか
+))
+```
+
+
+
+### Parameters
+**`page`** 
+  
+
+取得したいページ番号です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+1ページに表示する支払いQRコードの数です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`bill_id`** 
+  
+
+支払いQRコードのIDを指定して検索します。IDは前方一致で検索されます。
+
+```json
+{
+  "type": "string"
+}
+```
+
+**`private_money_id`** 
+  
+
+支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`organization_code`** 
+  
+
+支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
+
+```json
+{
+  "type": "string",
+  "maxLength": 32,
+  "pattern": "^[a-zA-Z0-9-]*$"
+}
+```
+
+**`description`** 
+  
+
+支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
+
+```json
+{
+  "type": "string",
+  "maxLength": 200
+}
+```
+
+**`created_from`** 
+  
+
+支払いQRコードの作成日時でフィルターします。
+
+これ以降に作成された支払いQRコードのみ一覧に表示されます。
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+**`created_to`** 
+  
+
+支払いQRコードの作成日時でフィルターします。
+
+これ以前に作成された支払いQRコードのみ一覧に表示されます。
+
+```json
+{
+  "type": "string",
+  "format": "date-time"
+}
+```
+
+**`shop_name`** 
+  
+
+支払いQRコードを作成した店舗名でフィルターします。店舗名は部分一致で検索されます。
+
+```json
+{
+  "type": "string",
+  "maxLength": 256
+}
+```
+
+**`shop_id`** 
+  
+
+支払いQRコードを作成した店舗IDでフィルターします。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`lower_limit_amount`** 
+  
+
+支払いQRコードの金額の下限を指定してフィルターします。
+
+```json
+{
+  "type": "integer",
+  "format": "decimal",
+  "minimum": 0
+}
+```
+
+**`upper_limit_amount`** 
+  
+
+支払いQRコードの金額の上限を指定してフィルターします。
+
+```json
+{
+  "type": "integer",
+  "format": "decimal",
+  "minimum": 0
+}
+```
+
+**`is_disabled`** 
+  
+
+支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
+
+```json
+{
+  "type": "boolean"
+}
+```
+
+
+
+成功したときは
+[PaginatedBills](./responses.md#paginated-bills)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+
+
+
+---
+
+
+<a name="create-bill"></a>
+## CreateBill: 支払いQRコードの発行
+支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: 支払いマネーのマネーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # shop_id: 支払い先(受け取り人)の店舗ID
+                          amount: 8753.0,                                       # 支払い額
+                          description: "test bill"                              # 説明文(アプリ上で取引の説明文として表示される)
+))
+```
+
+
+
+### Parameters
+**`amount`** 
+  
+
+支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+```json
+{
+  "type": "number",
+  "format": "decimal",
+  "minimum": 0
+}
+```
+
+**`private_money_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`shop_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`description`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 200
+}
+```
+
+
+
+成功したときは
+[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|
+
+
+
+---
+
+
+<a name="update-bill"></a>
+## UpdateBill: 支払いQRコードの更新
+支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
+
+```RUBY
+response = $client.send(Pokepay::Request::UpdateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # bill_id: 支払いQRコードのID
+                          amount: 3844.0,                                       # 支払い額
+                          description: "test bill",                             # 説明文
+                          is_disabled: false                                    # 無効化されているかどうか
+))
+```
+
+
+
+### Parameters
+**`bill_id`** 
+  
+
+更新対象の支払いQRコードのIDです。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`amount`** 
+  
+
+支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+```json
+{
+  "type": "number",
+  "format": "decimal",
+  "minimum": 0
+}
+```
+
+**`description`** 
+  
+
+支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
+
+```json
+{
+  "type": "string",
+  "maxLength": 200
+}
+```
+
+**`is_disabled`** 
+  
+
+支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
+
+```json
+{
+  "type": "boolean"
+}
+```
+
+
+
+成功したときは
+[Bill](./responses.md#bill)
+を返します
+
+
+
+---
+
+
+

data/docs/bulk.md

@@ -0,0 +1,121 @@
+# Bulk
+
+<a name="bulk-create-transaction"></a>
+## BulkCreateTransaction: CSVファイル一括取引
+CSVファイルから一括取引をします。
+
+```RUBY
+response = $client.send(Pokepay::Request::BulkCreateTransaction.new(
+                          "vOJkxhc8IPvtQD4QxNm6tX",                             # name: 一括取引タスク名
+                          "3Guvbo",                                             # content: 取引する情報のCSV
+                          "2vDNfvQpElqxJKgNyOMeXS2rUoCJ5iHqorIs",               # request_id: リクエストID
+                          description: "Pc2cBsLEwskU0m8hSr1melepO9LnwIsUcSmvb4GOUqCz9cGDIhlPt52zP7YS2DWusWLcKpd2P335Nv6jpCTg7cImjgcPmkAEumRe3ajMg8VGC0KZL7VMaMEG", # 一括取引の説明
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" # マネーID
+))
+```
+
+
+
+### Parameters
+**`name`** 
+  
+
+一括取引タスクの管理用の名前です。
+
+```json
+{
+  "type": "string",
+  "maxLength": 32
+}
+```
+
+**`description`** 
+  
+
+一括取引タスクの管理用の説明文です。
+
+```json
+{
+  "type": "string",
+  "maxLength": 128
+}
+```
+
+**`content`** 
+  
+
+一括取引する情報を書いたCSVの文字列です。
+1行目はヘッダ行で、2行目以降の各行にカンマ区切りの取引データを含みます。
+カラムは以下の7つです。任意のカラムには空文字を指定します。
+
+- `type`: 取引種別
+  - 必須。'topup' または 'payment'
+- `sender_id`: 送金ユーザーID
+  - 必須。UUID
+- `receiver_id`: 受取ユーザーID
+  - 必須。UUID
+- `private_money_id`: マネーID
+  - 必須。UUID
+- `money_amount`: マネー額
+  - 任意。ただし `point_amount` といずれかが必須。0以上の数字
+- `point_amount`: ポイント額
+  - 任意。ただし `money_amount` といずれかが必須。0以上の数字
+- `description`: 取引の説明文
+  - 任意。200文字以内。取引履歴に表示される文章
+- `bear_account_id`: ポイント負担ウォレットID
+  - `point_amount` があるときは必須。UUID
+- `point_expires_at`: ポイントの有効期限
+  - 任意。指定がないときはマネーに設定された有効期限を適用
+
+```json
+{
+  "type": "string"
+}
+```
+
+**`request_id`** 
+  
+
+重複したリクエストを判断するためのユニークID。ランダムな36字の文字列を生成して渡してください。
+
+```json
+{
+  "type": "string",
+  "minLength": 36,
+  "maxLength": 36
+}
+```
+
+**`private_money_id`** 
+  
+
+マネーIDです。 マネーを指定します。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[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|
+
+
+
+---
+
+
+