pokepay_partner_ruby_sdk 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fd61e182a33f59658adeb782593d28971cc70072d3d434b8880ba51d1348e81
-  data.tar.gz: 26dae7ac67ff5e10e2ab44f7e1fe2c03efcf30616e2cab5cb755b6bf757518fc
+  metadata.gz: 9db39bf7da512ddaf415d0312da429572674806d75d1a5beca492a8e10860f4b
+  data.tar.gz: 843b0548ce65832615325185665fd702b52dadcc13deadb0f0a3edbd7123d6a5
 SHA512:
-  metadata.gz: 5e2b87c098a019491ffac0b7744d672747cbc0a6a1756e4d7b6ce61da8dc765e4d05b61522eb206a27618c0bf793a7c7c89f03aa1e761e0dde503f5b6e999926
-  data.tar.gz: d8fd52165e868d36d33de7e96637cd02d30fb99107ca74b1b8964c2780bf16cee298c2af817cd1983a6a149e932495a4c17a72261ce12c7b73e6e8d37b42a58d
+  metadata.gz: 174b9e30acfcd57947de69f0860fb0def5703b4a35b6d90931760bcf604799bb6c5bd2e6d43428929a53452b88eb2736ed013d0e32646254ca7547f03906ce2e
+  data.tar.gz: ab2167de48835f66b92a3db675e768288736ad04376a76d2415b291d2146888ad6c24296ce345436a2bfa23f24da15169b7ec94bea7513452302d96122c1d07d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pokepay_partner_ruby_sdk (0.1.6)
+    pokepay_partner_ruby_sdk (0.1.7)
       inifile (~> 3.0.0)
       json (~> 2.3.0)
       openssl (~> 2.1.2)

data/docs/index.md

@@ -169,8 +169,8 @@ response = $client.send(Pokepay::Request::CreateTopupTransaction.new(
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // customer_id: エンドユーザーのID
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
                           bear_point_shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // ポイント支払時の負担店舗ID
-                          money_amount: 3515,                                   // マネー額
-                          point_amount: 7853,                                   // ポイント額
+                          money_amount: 8987,                                   // マネー額
+                          point_amount: 750,                                    // ポイント額
                           description: "初夏のチャージキャンペーン"                          // 取引履歴に表示する説明文
 ))
 ```
@@ -229,7 +229,7 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // shop_id: 店舗ID
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // customer_id: エンドユーザーID
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
-                          4119,                                                 // amount: 支払い額
+                          8123,                                                 // amount: 支払い額
                           description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
 ))
 ```
@@ -267,12 +267,59 @@ response = $client.send(Pokepay::Request::CreatePaymentTransaction.new(
 ---
 成功したときは[Transaction](#transaction)オブジェクトを返します
 
+#### 個人間送金
+エンドユーザー間での送金取引(個人間送金)を作成します。
+個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
+
+```ruby
+response = $client.send(Pokepay::Request::CreateTransferTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // sender_id: 送金元ユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // receiver_id: 受取ユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          7070,                                                 // amount: 送金額
+                          description: "たい焼き(小倉)"                               // 取引履歴に表示する説明文
+))
+```
+
+---
+`sender_id`  
+エンドユーザーIDです。
+
+送金元のエンドユーザー(送り主)を指定します。
+
+---
+`receiver_id`  
+エンドユーザーIDです。
+
+送金先のエンドユーザー(受け取り人)を指定します。
+
+---
+`private_money_id`  
+マネーIDです。
+
+マネーを指定します。
+
+---
+`amount`  
+マネー額です。
+
+送金するマネー額を指定します。
+
+---
+`description`  
+取引説明文です。
+
+任意入力で、取引履歴に表示される説明文です。
+
+---
+成功したときは[Transaction](#transaction)オブジェクトを返します
+
 #### 取引履歴を取得する
 取引一覧を返します。
 ```ruby
 response = $client.send(Pokepay::Request::ListTransactions.new(
-                          from: "2024-03-14T02:41:24.000000+09:00",             // 開始日時
-                          to: "2019-04-09T15:58:53.000000+09:00",               // 終了日時
+                          from: "2016-11-19T02:36:58.000000+09:00",             // 開始日時
+                          to: "2021-03-05T00:00:07.000000+09:00",               // 終了日時
                           page: 1,                                              // ページ番号
                           per_page: 50,                                         // 1ページ分の取引数
                           shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      // 店舗ID
@@ -400,13 +447,13 @@ QRコードを読み取る方法以外にも、このURLリンクを直接スマ
 ```ruby
 response = $client.send(Pokepay::Request::CreateCheck.new(
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: 送金元の店舗アカウントID
-                          money_amount: 9919,                                   // 付与マネー額
-                          point_amount: 2608,                                   // 付与ポイント額
+                          money_amount: 8455,                                   // 付与マネー額
+                          point_amount: 6119,                                   // 付与ポイント額
                           description: "test check",                            // 説明文(アプリ上で取引の説明文として表示される)
-                          is_onetime: false,                                    // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
-                          usage_limit: 8625,                                    // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
-                          expires_at: "2022-02-18T00:32:55.000000+09:00",       // チャージQR自体の失効日時
-                          point_expires_at: "2017-12-02T22:53:00.000000+09:00", // チャージQRによって付与されるポイントの失効日時
+                          is_onetime: true,                                     // ワンタイムかどうか。真の場合1度読み込まれた時点でそのチャージQRは失効する(デフォルト値は真)
+                          usage_limit: 4746,                                    // ワンタイムでない場合、複数ユーザから読み取られ得る。その場合の最大読み取り回数
+                          expires_at: "2018-04-09T08:22:29.000000+09:00",       // チャージQR自体の失効日時
+                          point_expires_at: "2016-10-24T09:19:20.000000+09:00", // チャージQRによって付与されるポイントの失効日時
                           point_expires_in_days: 60,                            // チャージQRによって付与されるポイントの有効期限(相対指定、単位は日)
                           bear_point_account: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // ポイント額を負担する店舗アカウントのID
 ))
@@ -457,6 +504,135 @@ QRコード生成時に送金元店舗のウォレット情報や、送金額な
 ---
 成功したときは[Transaction](#transaction)オブジェクトを返します
 
+### 支払いQRコード
+
+#### 支払いQRコード一覧を表示する
+支払いQRコード一覧を表示します。
+```ruby
+response = $client.send(Pokepay::Request::ListBills.new(
+                          page: 9486,                                           // ページ番号
+                          per_page: 5839,                                       // 1ページの表示数
+                          bill_id: "1Ez",                                       // 支払いQRコードのID
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
+                          organization_code: "1rDRdnXy6PY122A---0nzUq-g",       // 組織コード
+                          description: "test bill",                             // 取引説明文
+                          created_from: "2017-11-03T07:17:36.000000+09:00",     // 作成日時(起点)
+                          created_to: "2016-02-19T04:37:01.000000+09:00",       // 作成日時(終点)
+                          shop_name: "bill test shop1",                         // 店舗名
+                          shop_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",      // 店舗ID
+                          lower_limit_amount: 8463,                             // 金額の範囲によるフィルタ(下限)
+                          upper_limit_amount: 3110,                             // 金額の範囲によるフィルタ(上限)
+                          is_disabled: true                                     // 支払いQRコードが無効化されているかどうか
+))
+```
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページに表示する支払いQRコードの数です。
+
+---
+`bill_id`  
+支払いQRコードのIDを指定して検索します。IDは部分一致で検索できます。
+
+---
+`private_money_id`  
+支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
+
+---
+`organization_code`  
+支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
+
+---
+`description`  
+支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
+
+---
+`created_from`  
+支払いQRコードの作成日時でフィルターします。
+
+これ以降に作成された支払いQRコードのみ一覧に表示されます。
+
+---
+`created_to`  
+支払いQRコードの作成日時でフィルターします。
+
+これ以前に作成された支払いQRコードのみ一覧に表示されます。
+
+---
+`shop_name`  
+支払いQRコードを作成した店舗名でフィルターします。
+
+---
+`shop_id`  
+支払いQRコードを作成した店舗IDでフィルターします。
+
+---
+`lower_limit_amount`  
+支払いQRコードの金額の下限を指定してフィルターします。
+
+---
+`upper_limit_amount`  
+支払いQRコードの金額の上限を指定してフィルターします。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
+
+---
+成功したときは[PaginatedBills](#paginated-bills)オブジェクトを返します
+
+#### 支払い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: 9236,                                         // 支払い額
+                          description: "test bill"                              // 説明文(アプリ上で取引の説明文として表示される)
+))
+```
+
+---
+`amount`  
+支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+
+#### 支払いQRコードの更新
+支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
+```ruby
+response = $client.send(Pokepay::Request::UpdateBill.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // bill_id: 支払いQRコードのID
+                          amount: 1515,                                         // 支払い額
+                          description: "test bill",                             // 説明文
+                          is_disabled: true                                     // 無効化されているかどうか
+))
+```
+
+---
+`bill_id`  
+更新対象の支払いQRコードのIDです。
+
+---
+`amount`  
+支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+
+---
+`description`  
+支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
+
+---
+`is_disabled`  
+支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
+
+---
+成功したときは[Bill](#bill)オブジェクトを返します
+
 ### Customer
 
 #### 新規エンドユーザーウォレットを追加する
@@ -486,7 +662,7 @@ response = $client.send(Pokepay::Request::CreateCustomerAccount.new(
 ---
 成功したときは[AccountWithUser](#account-with-user)オブジェクトを返します
 
-#### エンドユーザーのウォレット情報を表示する
+#### ウォレット情報を表示する
 ウォレットを取得します。
 ```ruby
 response = $client.send(Pokepay::Request::GetAccount.new(
@@ -504,12 +680,15 @@ response = $client.send(Pokepay::Request::GetAccount.new(
 成功したときは[AccountDetail](#account-detail)オブジェクトを返します
 
 #### エンドユーザーの残高内訳を表示する
-エンドユーザーの残高は有効期限別のリストとして取得できます。
+エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
 ```ruby
 response = $client.send(Pokepay::Request::ListAccountBalances.new(
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: ウォレットID
-                          page: 7956,                                           // ページ番号
-                          per_page: 4513                                        // 1ページ分の取引数
+                          page: 2589,                                           // ページ番号
+                          per_page: 6451,                                       // 1ページ分の取引数
+                          expires_at_from: "2024-03-14T23:56:23.000000+09:00",  // 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2019-10-04T17:19:48.000000+09:00",    // 有効期限の期間によるフィルター(終了時点)
+                          direction: "asc"                                      // 有効期限によるソート順序
 ))
 ```
 
@@ -521,15 +700,148 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
 
 ---
 `page`  
-取得したいページ番号です。
+取得したいページ番号です。デフォルト値は1です。
 
 ---
 `per_page`  
-1ページ分のウォレット残高数です。
+1ページ分のウォレット残高数です。デフォルト値は30です。
+
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
 
 ---
 成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
 
+#### エンドユーザーの失効済みの残高内訳を表示する
+エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListAccountExpiredBalances.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // account_id: ウォレットID
+                          page: 6958,                                           // ページ番号
+                          per_page: 2994,                                       // 1ページ分の取引数
+                          expires_at_from: "2016-02-15T00:43:30.000000+09:00",  // 有効期限の期間によるフィルター(開始時点)
+                          expires_at_to: "2016-06-15T15:33:00.000000+09:00",    // 有効期限の期間によるフィルター(終了時点)
+                          direction: "asc"                                      // 有効期限によるソート順序
+))
+```
+
+---
+`account_id`  
+ウォレットIDです。
+
+フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+
+---
+`page`  
+取得したいページ番号です。デフォルト値は1です。
+
+---
+`per_page`  
+1ページ分のウォレット残高数です。デフォルト値は30です。
+
+---
+`expires_at_from`  
+有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`expires_at_to`  
+有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+
+---
+`direction`  
+有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
+
+---
+成功したときは[PaginatedAccountBalance](#paginated-account-balance)オブジェクトを返します
+
+#### 取引履歴を取得する
+取引一覧を返します。
+```ruby
+response = $client.send(Pokepay::Request::ListCustomerTransactions.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
+                          sender_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 送金エンドユーザーID
+                          receiver_customer_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // 受取エンドユーザーID
+                          type: "FjJy7",                                        // 取引種別、チャージ=topup、支払い=payment、個人間送金=transfer
+                          is_modified: true,                                    // キャンセル済みかどうか
+                          from: "2019-01-09T15:47:03.000000+09:00",             // 開始日時
+                          to: "2025-02-14T22:55:32.000000+09:00",               // 終了日時
+                          page: 1,                                              // ページ番号
+                          per_page: 50                                          // 1ページ分の取引数
+))
+```
+
+---
+`private_money_id`  
+マネーIDです。
+フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
+
+---
+`sender_customer_id`  
+送金ユーザーIDです。
+
+フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
+
+---
+`receiver_customer_id`  
+受取ユーザーIDです。
+
+フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
+
+---
+`type`  
+取引の種類でフィルターします。
+
+以下の種類を指定できます。
+
+1. topup
+   店舗からエンドユーザーへの送金取引(チャージ)
+2. payment
+   エンドユーザーから店舗への送金取引(支払い)
+3. exchange
+   他マネーへの流出(outflow)/他マネーからの流入(inflow)
+4. transfer
+   個人間送金
+
+---
+`is_modified`  
+キャンセル済みかどうかを判定するフラグです。
+
+これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+falseを指定するとキャンセルされていない取引のみ一覧に表示されます
+何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
+
+---
+`from`  
+抽出期間の開始日時です。
+
+フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+
+---
+`to`  
+抽出期間の終了日時です。
+
+フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedTransaction](#paginated-transaction)オブジェクトを返します
+
 ### Organization
 
 #### 新規加盟店組織を追加する
@@ -537,14 +849,14 @@ response = $client.send(Pokepay::Request::ListAccountBalances.new(
 response = $client.send(Pokepay::Request::CreateOrganization.new(
                           "ox_supermarket",                                     // code: 新規組織コード
                           "oxスーパー",                                             // name: 新規組織名
-                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],             // private_money_ids: 加盟店組織で有効にするマネーIDの配列
-                          "1qSYlEPOrX@96su.com",                                // issuer_admin_user_email: 発行体担当者メールアドレス
-                          "Y89xlB3mgj@Y6Ph.com",                                // member_admin_user_email: 新規組織担当者メールアドレス
+                          ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"], // private_money_ids: 加盟店組織で有効にするマネーIDの配列
+                          "Kkoz4u4vqN@tkYj.com",                                // issuer_admin_user_email: 発行体担当者メールアドレス
+                          "PXUyJ1V0r5@CHRN.com",                                // member_admin_user_email: 新規組織担当者メールアドレス
                           bank_name: "XYZ銀行",                                   // 銀行名
                           bank_code: "99X",                                     // 銀行金融機関コード
                           bank_branch_name: "ABC支店",                            // 銀行支店名
                           bank_branch_code: "99X",                              // 銀行支店コード
-                          bank_account_type: "current",                         // 銀行口座種別 (普通=saving, 当座=current, その他=other)
+                          bank_account_type: "saving",                          // 銀行口座種別 (普通=saving, 当座=current, その他=other)
                           bank_account: 9999999,                                // 銀行口座番号
                           bank_account_holder_name: "ﾌｸｻﾞﾜﾕｷﾁ",                 // 口座名義人名
                           contact_name: "佐藤清"                                   // 担当者名
@@ -558,24 +870,74 @@ response = $client.send(Pokepay::Request::CreateOrganization.new(
 ```ruby
 response = $client.send(Pokepay::Request::CreateShop.new(
                           "oxスーパー三田店",                                          // shop_name: 店舗名
-                          shop_postal_code: "652-4859",                         // 店舗の郵便番号
+                          shop_postal_code: "422-5364",                         // 店舗の郵便番号
                           shop_address: "東京都港区芝...",                            // 店舗の住所
-                          shop_tel: "096-99-5223",                              // 店舗の電話番号
-                          shop_email: "0ktWQ723w2@IG1J.com",                    // 店舗のメールアドレス
-                          shop_external_id: "lBzqgWY2glpsEhUQhgL9hEwO7oPQpA",   // 店舗の外部ID
+                          shop_tel: "083-33-947",                               // 店舗の電話番号
+                          shop_email: "pSCBGnb27K@I1Ko.com",                    // 店舗のメールアドレス
+                          shop_external_id: "9Ro9P2UOPHKc",                     // 店舗の外部ID
                           organization_code: "ox-supermarket"                   // 組織コード
 ))
 ```
 成功したときは[User](#user)オブジェクトを返します
 
+#### 店舗一覧を取得する
+```ruby
+response = $client.send(Pokepay::Request::ListShops.new(
+                          organization_code: "pocketchange",                    // 組織コード
+                          private_money_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // マネーID
+                          page: 1,                                              // ページ番号
+                          per_page: 50                                          // 1ページ分の取引数
+))
+```
+
+---
+`organization_code`  
+このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
+
+
+---
+`private_money_id`  
+このパラメータを渡すとそのマネーのウォレットを持つ店舗のみが返されます。
+
+
+---
+`page`  
+取得したいページ番号です。
+
+---
+`per_page`  
+1ページ分の取引数です。
+
+---
+成功したときは[PaginatedShops](#paginated-shops)オブジェクトを返します
+
+### Account
+
+#### エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
+```ruby
+response = $client.send(Pokepay::Request::ListUserAccounts.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                // user_id: ユーザーID
+))
+```
+
+---
+`user_id`  
+ユーザーIDです。
+
+指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
+
+---
+成功したときは[PaginatedAccounts](#paginated-accounts)オブジェクトを返します
+
 ### Private Money
 
 #### 決済加盟店の取引サマリを取得する
 ```ruby
 response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.new(
                           "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               // private_money_id: マネーID
-                          from: "2017-05-21T20:37:05.000000+09:00",             // 開始日時(toと同時に指定する必要有)
-                          to: "2018-07-11T00:21:30.000000+09:00",               // 終了日時(fromと同時に指定する必要有)
+                          from: "2020-03-02T19:54:29.000000+09:00",             // 開始日時(toと同時に指定する必要有)
+                          to: "2024-10-09T07:46:14.000000+09:00",               // 終了日時(fromと同時に指定する必要有)
                           page: 1,                                              // ページ番号
                           per_page: 50                                          // 1ページ分の取引数
 ))
@@ -586,6 +948,7 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
 
 ## Responses
 
+
 <a name="account-with-user"></a>
 ## AccountWithUser
 * `id (string)`: 
@@ -610,6 +973,19 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
 
 `private_money`は [PrivateMoney](#private-money) オブジェクトを返します。
 
+<a name="bill"></a>
+## Bill
+* `id (string)`: 支払いQRコードのID
+* `amount (double)`: 支払い額
+* `max_amount (double)`: 支払い額を範囲指定した場合の上限
+* `min_amount (double)`: 支払い額を範囲指定した場合の下限
+* `description (string)`: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
+* `account (AccountWithUser)`: 支払いQRコード発行ウォレット
+* `is_disabled (boolean)`: 無効化されているかどうか
+* `token (string)`: 
+
+`account`は [AccountWithUser](#account-with-user) オブジェクトを返します。
+
 <a name="check"></a>
 ## Check
 * `id (string)`: チャージQRコードのID
@@ -695,6 +1071,16 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
 
 `pagination`は [Pagination](#pagination) オブジェクトを返します。
 
+<a name="paginated-accounts"></a>
+## PaginatedAccounts
+* `rows (array of Accounts)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Account](#account) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
 <a name="paginated-account-balance"></a>
 ## PaginatedAccountBalance
 * `rows (array of AccountBalances)`: 
@@ -705,6 +1091,26 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
 
 `pagination`は [Pagination](#pagination) オブジェクトを返します。
 
+<a name="paginated-shops"></a>
+## PaginatedShops
+* `rows (array of ShopWithMetadatas)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [ShopWithMetadata](#shop-with-metadata) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
+<a name="paginated-bills"></a>
+## PaginatedBills
+* `rows (array of Bills)`: 
+* `count (integer)`: 
+* `pagination (Pagination)`: 
+
+`rows`は [Bill](#bill) オブジェクトの配列を返します。
+
+`pagination`は [Pagination](#pagination) オブジェクトを返します。
+
 <a name="private-money"></a>
 ## PrivateMoney
 * `id (string)`: マネーID
@@ -763,3 +1169,14 @@ response = $client.send(Pokepay::Request::GetPrivateMoneyOrganizationSummaries.n
 * `expires_at (string)`: 
 * `money_amount (double)`: 
 * `point_amount (double)`: 
+
+<a name="shop-with-metadata"></a>
+## ShopWithMetadata
+* `id (string)`: 店舗ID
+* `name (string)`: 店舗名
+* `organization_code (string)`: 組織コード
+* `postal_code (string)`: 店舗の郵便番号
+* `address (string)`: 店舗の住所
+* `tel (string)`: 店舗の電話番号
+* `email (string)`: 店舗のメールアドレス
+* `external_id (string)`: 店舗の外部ID

data/lib/pokepay_partner_ruby_sdk.rb

@@ -12,8 +12,11 @@ require "pokepay_partner_ruby_sdk/request/list_user_accounts"
 require "pokepay_partner_ruby_sdk/request/get_account"
 require "pokepay_partner_ruby_sdk/request/update_account"
 require "pokepay_partner_ruby_sdk/request/list_account_balances"
+require "pokepay_partner_ruby_sdk/request/list_account_expired_balances"
 require "pokepay_partner_ruby_sdk/request/create_customer_account"
 require "pokepay_partner_ruby_sdk/request/list_bills"
+require "pokepay_partner_ruby_sdk/request/create_bill"
+require "pokepay_partner_ruby_sdk/request/update_bill"
 require "pokepay_partner_ruby_sdk/request/create_check"
 require "pokepay_partner_ruby_sdk/request/list_transactions"
 require "pokepay_partner_ruby_sdk/request/create_transaction"
@@ -29,6 +32,7 @@ require "pokepay_partner_ruby_sdk/request/create_organization"
 require "pokepay_partner_ruby_sdk/request/list_shops"
 require "pokepay_partner_ruby_sdk/request/create_shop"
 require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries"
+require "pokepay_partner_ruby_sdk/request/list_customer_transactions"
 require "pokepay_partner_ruby_sdk/response/pong"
 require "pokepay_partner_ruby_sdk/response/echo"
 require "pokepay_partner_ruby_sdk/response/pagination"

data/lib/pokepay_partner_ruby_sdk/request/create_bill.rb

@@ -0,0 +1,16 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/bill"
+
+module Pokepay::Request
+  class CreateBill < Request
+    def initialize(private_money_id, shop_id, rest_args = {})
+      @path = "/bills"
+      @method = "POST"
+      @body_params = { "private_money_id" => private_money_id,
+                       "shop_id" => shop_id }.merge(rest_args)
+      @response_class = Pokepay::Response::Bill
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/list_account_expired_balances.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
+
+module Pokepay::Request
+  class ListAccountExpiredBalances < Request
+    def initialize(account_id, rest_args = {})
+      @path = "/accounts" + "/" + account_id + "/expired-balances"
+      @method = "GET"
+      @body_params = {  }.merge(rest_args)
+      @response_class = Pokepay::Response::PaginatedAccountBalance
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/list_customer_transactions.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/paginated_transaction"
+
+module Pokepay::Request
+  class ListCustomerTransactions < Request
+    def initialize(private_money_id, rest_args = {})
+      @path = "/customers" + "/transactions"
+      @method = "GET"
+      @body_params = { "private_money_id" => private_money_id }.merge(rest_args)
+      @response_class = Pokepay::Response::PaginatedTransaction
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/update_bill.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/bill"
+
+module Pokepay::Request
+  class UpdateBill < Request
+    def initialize(bill_id, rest_args = {})
+      @path = "/bills" + "/" + bill_id
+      @method = "PATCH"
+      @body_params = {  }.merge(rest_args)
+      @response_class = Pokepay::Response::Bill
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/response/bill.rb

@@ -12,6 +12,7 @@ module Pokepay::Response
       @description = row["description"]
       @account = AccountWithUser.new(row["account"])
       @is_disabled = row["is_disabled"]
+      @token = row["token"]
     end
     attr_reader :id
     attr_reader :amount
@@ -20,5 +21,6 @@ module Pokepay::Response
     attr_reader :description
     attr_reader :account
     attr_reader :is_disabled
+    attr_reader :token
   end
 end

data/lib/pokepay_partner_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module Pokepay
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/partner.yaml

@@ -165,6 +165,9 @@ components:
         is_disabled:
           type: boolean
           summary: 無効化されているかどうか
+        token:
+          type: string
+          description: 支払いQRコードを解析したときに出てくるURL
     Check:
       x-pokepay-schema-type: "response"
       properties:
@@ -771,7 +774,7 @@ paths:
           $ref: '#/components/responses/NotFound'
   /accounts/{account_id}:
     get:
-      summary: 'エンドユーザーのウォレット情報を表示する'
+      summary: 'ウォレット情報を表示する'
       description: ウォレットを取得します。
       x-pokepay-operator-name: "GetAccount"
       x-pokepay-allow-server-side: true
@@ -801,6 +804,7 @@ paths:
         '404':
           $ref: '#/components/responses/NotFound'
     patch:
+      summary: 'ウォレット情報を更新する'
       description: ウォレットの状態を更新します。現在はウォレットの凍結/凍結解除の切り替えにのみ対応しています。
       x-pokepay-operator-name: "UpdateAccount"
       x-pokepay-allow-server-side: true
@@ -811,6 +815,7 @@ paths:
           schema:
             type: string
             format: uuid
+          summary: 'ウォレットID'
           description: |-
             ウォレットIDです。
 
@@ -823,6 +828,7 @@ paths:
               properties:
                 is_suspended:
                   type: boolean
+                  summary: 'ウォレットが凍結されているかどうか'
                   description: ウォレットの凍結状態です。真にするとウォレットが凍結され、そのウォレットでは新規取引ができなくなります。偽にすると凍結解除されます。
       responses:
         '200':
@@ -840,7 +846,7 @@ paths:
   /accounts/{account_id}/balances:
     get:
       summary: 'エンドユーザーの残高内訳を表示する'
-      description: エンドユーザーの残高は有効期限別のリストとして取得できます。
+      description: エンドユーザーのウォレット毎の残高を有効期限別のリストとして取得します。
       x-pokepay-operator-name: "ListAccountBalances"
       x-pokepay-allow-server-side: true
       parameters:
@@ -865,12 +871,89 @@ paths:
                   type: integer
                   minimum: 1
                   summary: 'ページ番号'
-                  description: 取得したいページ番号です。
+                  description: 取得したいページ番号です。デフォルト値は1です。
                 per_page:
                   type: integer
                   minimum: 1
                   summary: '1ページ分の取引数'
-                  description: 1ページ分のウォレット残高数です。
+                  description: 1ページ分のウォレット残高数です。デフォルト値は30です。
+                expires_at_from:
+                  type: string
+                  format: date-time
+                  summary: '有効期限の期間によるフィルター(開始時点)'
+                  description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+                expires_at_to:
+                  type: string
+                  format: date-time
+                  summary: '有効期限の期間によるフィルター(終了時点)'
+                  description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+                direction:
+                  type: string
+                  enum: [asc, desc]
+                  summary: '有効期限によるソート順序'
+                  description: 有効期限によるソートの順序を指定します。デフォルト値はasc (昇順)です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedAccountBalance'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+  /accounts/{account_id}/expired-balances:
+    get:
+      summary: 'エンドユーザーの失効済みの残高内訳を表示する'
+      description: エンドユーザーのウォレット毎の失効済みの残高を有効期限別のリストとして取得します。
+      x-pokepay-operator-name: "ListAccountExpiredBalances"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - name: account_id
+          in: path
+          required: true
+          schema:
+            type: string
+            format: uuid
+          summary: 'ウォレットID'
+          description: |-
+            ウォレットIDです。
+
+            フィルターとして使われ、指定したウォレットIDのウォレット残高を取得します。
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                page:
+                  type: integer
+                  minimum: 1
+                  summary: 'ページ番号'
+                  description: 取得したいページ番号です。デフォルト値は1です。
+                per_page:
+                  type: integer
+                  minimum: 1
+                  summary: '1ページ分の取引数'
+                  description: 1ページ分のウォレット残高数です。デフォルト値は30です。
+                expires_at_from:
+                  type: string
+                  format: date-time
+                  summary: '有効期限の期間によるフィルター(開始時点)'
+                  description: 有効期限の期間によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+                expires_at_to:
+                  type: string
+                  format: date-time
+                  summary: '有効期限の期間によるフィルター(終了時点)'
+                  description: 有効期限の期間によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+                direction:
+                  type: string
+                  enum: [asc, desc]
+                  summary: '有効期限によるソート順序'
+                  description: 有効期限によるソートの順序を指定します。デフォルト値はdesc (降順)です。
       responses:
         '200':
           description: OK
@@ -1030,6 +1113,104 @@ paths:
           $ref: '#/components/responses/BadRequest'
         '403':
           $ref: '#/components/responses/Forbidden'
+    post:
+      summary: '支払いQRコードの発行'
+      description: 支払いQRコードの内容を更新します。支払い先の店舗ユーザーは指定したマネーのウォレットを持っている必要があります。
+      x-pokepay-operator-name: "CreateBill"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id", "shop_id"]
+              properties:
+                amount:
+                  type: number
+                  minimum: 0
+                  nullable: true
+                  format: decimal
+                  summary: '支払い額'
+                  description: 支払いQRコードを支払い額を指定します。省略するかnullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+                private_money_id:
+                  type: string
+                  format: uuid
+                  summary: '支払いマネーのマネーID'
+                shop_id:
+                  type: string
+                  format: uuid
+                  summary: '支払い先(受け取り人)の店舗ID'
+                description:
+                  type: string
+                  maxLength: 200
+                  summary: '説明文(アプリ上で取引の説明文として表示される)'
+                  example: 'test bill'
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Bill'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+
+  /bills/{bill_id}:
+    patch:
+      summary: '支払いQRコードの更新'
+      description: 支払いQRコードの内容を更新します。パラメータは全て省略可能で、指定したもののみ更新されます。
+      x-pokepay-operator-name: "UpdateBill"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: bill_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+          summary: '支払いQRコードのID'
+          description: |-
+            更新対象の支払いQRコードのIDです。
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                amount:
+                  type: number
+                  minimum: 0
+                  nullable: true
+                  format: decimal
+                  summary: '支払い額'
+                  description: 支払いQRコードを支払い額を指定します。nullを渡すと任意金額の支払いQRコードとなり、エンドユーザーがアプリで読み取った際に金額を入力します。
+                description:
+                  type: string
+                  maxLength: 200
+                  summary: '説明文'
+                  description: 支払いQRコードの詳細説明文です。アプリ上で取引の説明文として表示されます。
+                  example: 'test bill'
+                is_disabled:
+                  type: boolean
+                  summary: '無効化されているかどうか'
+                  description: 支払いQRコードが無効化されているかどうかを指定します。真にすると無効化され、偽にすると有効化します。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Bill'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
   /checks:
     post:
       summary: 'チャージQRコードの発行'
@@ -1965,3 +2146,105 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '404':
           $ref: '#/components/responses/NotFound'
+  /customers/transactions:
+    get:
+      summary: '取引履歴を取得する'
+      description: '取引一覧を返します。'
+      x-pokepay-operator-name: "ListCustomerTransactions"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  summary: 'マネーID'
+                  description: |-
+                    マネーIDです。
+                    フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
+                sender_customer_id:
+                  type: string
+                  format: uuid
+                  summary: '送金エンドユーザーID'
+                  description: |-
+                    送金ユーザーIDです。
+
+                    フィルターとして使われ、指定された送金ユーザーでの取引のみ一覧に表示されます。
+                receiver_customer_id:
+                  type: string
+                  format: uuid
+                  summary: '受取エンドユーザーID'
+                  description: |-
+                    受取ユーザーIDです。
+
+                    フィルターとして使われ、指定された受取ユーザーでの取引のみ一覧に表示されます。
+                type:
+                  type: string
+                  summary: '取引種別、チャージ=topup、支払い=payment、個人間送金=transfer'
+                  description: |-
+                    取引の種類でフィルターします。
+
+                    以下の種類を指定できます。
+
+                    1. topup
+                       店舗からエンドユーザーへの送金取引(チャージ)
+                    2. payment
+                       エンドユーザーから店舗への送金取引(支払い)
+                    3. exchange
+                       他マネーへの流出(outflow)/他マネーからの流入(inflow)
+                    4. transfer
+                       個人間送金
+                is_modified:
+                  type: boolean
+                  summary: 'キャンセル済みかどうか'
+                  description: |-
+                    キャンセル済みかどうかを判定するフラグです。
+
+                    これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+                    falseを指定するとキャンセルされていない取引のみ一覧に表示されます
+                    何も指定しなければキャンセルの有無にかかわらず一覧に表示されます。
+                from:
+                  type: string
+                  format: date-time
+                  summary: '開始日時'
+                  description: |-
+                    抽出期間の開始日時です。
+
+                    フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+                to:
+                  type: string
+                  format: date-time
+                  summary: '終了日時'
+                  description: |-
+                    抽出期間の終了日時です。
+
+                    フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+                page:
+                  type: integer
+                  minimum: 1
+                  summary: 'ページ番号'
+                  description: 取得したいページ番号です。
+                  example: 1
+                per_page:
+                  type: integer
+                  minimum: 1
+                  summary: '1ページ分の取引数'
+                  description: 1ページ分の取引数です。
+                  example: 50
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedTransaction'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pokepay_partner_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Pocket Change, Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ files:
 - lib/pokepay_partner_ruby_sdk.rb
 - lib/pokepay_partner_ruby_sdk/client.rb
 - lib/pokepay_partner_ruby_sdk/crypto.rb
+- lib/pokepay_partner_ruby_sdk/request/create_bill.rb
 - lib/pokepay_partner_ruby_sdk/request/create_check.rb
 - lib/pokepay_partner_ruby_sdk/request/create_customer_account.rb
 - lib/pokepay_partner_ruby_sdk/request/create_exchange_transaction.rb
@@ -132,7 +133,9 @@ files:
 - lib/pokepay_partner_ruby_sdk/request/get_transaction.rb
 - lib/pokepay_partner_ruby_sdk/request/get_user.rb
 - lib/pokepay_partner_ruby_sdk/request/list_account_balances.rb
+- lib/pokepay_partner_ruby_sdk/request/list_account_expired_balances.rb
 - lib/pokepay_partner_ruby_sdk/request/list_bills.rb
+- lib/pokepay_partner_ruby_sdk/request/list_customer_transactions.rb
 - lib/pokepay_partner_ruby_sdk/request/list_shops.rb
 - lib/pokepay_partner_ruby_sdk/request/list_transactions.rb
 - lib/pokepay_partner_ruby_sdk/request/list_transfers.rb
@@ -141,6 +144,7 @@ files:
 - lib/pokepay_partner_ruby_sdk/request/request.rb
 - lib/pokepay_partner_ruby_sdk/request/send_echo.rb
 - lib/pokepay_partner_ruby_sdk/request/update_account.rb
+- lib/pokepay_partner_ruby_sdk/request/update_bill.rb
 - lib/pokepay_partner_ruby_sdk/response/account.rb
 - lib/pokepay_partner_ruby_sdk/response/account_balance.rb
 - lib/pokepay_partner_ruby_sdk/response/account_detail.rb