pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097cdad55144b73fd04cbacc168dd804a322ee0c4d7c58058497d723b7f5c669'
-  data.tar.gz: 460878aadbb9c9fcecdbf19c8672a360cabd025d46acb1a62b1c5eea45c63cf1
+  metadata.gz: 7c26d818f8a48583f4c99798f0acbb1d7fc680660921b423ba22f3340922c14c
+  data.tar.gz: cb9f3689642620870ded66eaca10fdbf952f9e0f41307542c92373b00f89ef12
 SHA512:
-  metadata.gz: 3e95bcca8124bf6df64daa21b17554e7b6b6e3fd15c2d665148409cc5755fa5a000c3415004f00392bf172da1c1810777afe51d39465184bf909221d7622d637
-  data.tar.gz: d37dbce9f7e5920180d33f552fba6de0df78474b76d41b73ac018da83c18074d13ecbe520509023c2fdcd81fecd99a516f31a6f46762d0aca4712b71476226cb
+  metadata.gz: a0d6d8ac988718ef1e52d5c7510d10a5bc0766f1ba2499a503d8e23d15c7c3f87d5461f879c232912920a832afb11e08b4324f6fd632142084b7e539f365f749
+  data.tar.gz: 792addcccce3fe782d3dd23a89a42a4e8d4a1bbbfa2a5829c6cc29c10bbc510163915d4936524dade73a1945a0afc5bc6bc8b9c782dcd9f8ef248268335faaa8

data/.github/workflows/release-pr.yml

@@ -0,0 +1,18 @@
+name: release PR
+
+on:
+  push:
+    branches:
+      - release/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run a multi-line script
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create -B master -t ${{ github.ref }} -b ''

data/Gemfile.lock

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

data/docs/README.md

@@ -0,0 +1,269 @@
+# Partner API SDK for Ruby
+## Installation
+
+rubygemsからインストールすることができます。
+```
+$ gem install pokepay_partner_ruby_sdk
+```
+
+ロードパスの通ったところにライブラリが配置されていれば、以下のようにロードできます。
+
+```ruby
+require "pokepay_partner_ruby_sdk"
+```
+
+## Getting started
+
+基本的な使い方は次のようになります。
+
+- ライブラリをロード
+- 設定ファイル(後述)から `Pokepay::Client` オブジェクトを作る
+- リクエストオブジェクトを作り、`Pokepay::Client` オブジェクトの `send` メソッドに対して渡す
+- レスポンスオブジェクトを得る
+
+```ruby
+require "pokepay_partner_ruby_sdk"
+client = Pokepay::Client.new("/path/to/config.ini")
+request = Pokepay::Request::SendEcho.new('hello')
+response = client.send(request)
+```
+
+レスポンスオブジェクト内にステータスコード、JSONをパースしたハッシュマップ、さらにレスポンス内容のオブジェクトが含まれています。
+
+## Settings
+
+設定はINIファイルに記述し、`Pokepay::Client` のコンストラクタにファイルパスを指定します。
+
+SDKプロジェクトルートに `config.ini.sample` というファイルがありますのでそれを元に必要な情報を記述してください。特に以下の情報は通信の安全性のため必要な項目です。これらはパートナー契約時にお渡ししているものです。
+
+- `CLIENT_ID`: パートナーAPI クライアントID
+- `CLIENT_SECRET`: パートナーAPI クライアント秘密鍵
+- `SSL_KEY_FILE`: SSL秘密鍵ファイルパス
+- `SSL_CERT_FILE`: SSL証明書ファイルパス
+
+この他に接続先のサーバURL情報が必要です。
+
+- `API_BASE_URL`: パートナーAPI サーバURL
+
+また、この設定ファイルには認証に必要な情報が含まれるため、ファイルの管理・取り扱いに十分注意してください。
+
+設定ファイル記述例(`config.ini.sample`)
+
+```
+CLIENT_ID        = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+CLIENT_SECRET    = yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy
+API_BASE_URL     = https://partnerapi-sandbox.pokepay.jp
+SSL_KEY_FILE     = /path/to/key.pem
+SSL_CERT_FILE    = /path/to/cert.pem
+```
+
+設定はハッシュで渡すこともできます。
+
+```ruby
+client = Pokepay::Client.new(
+  {
+    client_id: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    client_secret: "yyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy",
+    api_base_url: "https://partnerapi-sandbox.pokepay.jp",
+    ssl_key_file: "/path/to/key.pem",
+    ssl_cert_file: "/path/to/cert.pem"
+  }
+)
+```
+
+## Overview
+
+### APIリクエスト
+
+Partner APIへの通信はリクエストオブジェクトを作り、`Pokepay::Client.send` メソッドに渡すことで行われます。  
+リクエストクラスは名前空間 `Pokepay::Request` 以下に定義されています。
+
+たとえば `Pokepay::Request::SendEcho` は送信した内容をそのまま返す処理です。
+
+```ruby
+request = Pokepay::Request::SendEcho.new('hello')
+
+response = client.send(request)
+# => #<Pokepay::Response::Response 200 OK readbody=>
+```
+
+通信の結果として、レスポンスオブジェクトが得られます。  
+これはステータスコードとレスポンスボディ、各レスポンスクラスのオブジェクトをインスタンス変数に持つオブジェクトです。
+
+```ruby
+response.code
+# => 200
+
+response.body
+# => {"status"=>"ok", "message"=>"hello"}
+
+response.object
+# => #<Pokepay::Response::Echo:0x000055fd7cc0db20 @message="hello">
+
+response.object.message
+# => "hello"
+```
+
+利用可能なAPI操作については [API Operations](#api-operations) で紹介します。
+
+<a name="paging"></a>
+### ページング
+
+API操作によっては、大量のデータがある場合に備えてページング処理があります。
+その処理では以下のようなプロパティを持つレスポンスオブジェクトを返します。
+
+- rows : 列挙するレスポンスクラスのオブジェクトの配列
+- count : 全体の要素数
+- pagination : 以下のインスタンス変数を持つオブジェクト
+  - current : 現在のページ位置(1からスタート)
+  - per_page : 1ページ当たりの要素数
+  - max_page : 最後のページ番号
+  - has_prev : 前ページを持つかどうかの真理値
+  - has_next : 次ページを持つかどうかの真理値
+
+ページングクラスは `Pokepay::Response::Pagination` で定義されています。
+
+以下にコード例を示します。
+
+```ruby
+request = Pokepay::Request::ListTransactions.new({ "page" => 1, "per_page" => 50 })
+response = client.send(request)
+
+if response.object.pagination.has_next then
+  next_page = response.object.pagination.current + 1
+  request = Pokepay::Request::ListTransactions.new({ "page" => next_page, "per_page" => 50 })
+  response = client.send(request)
+end
+```
+
+### エラーハンドリング
+
+エラーの場合は `Net::HTTPBadRequest` などのエラーレスポンスオブジェクトが返ります。  
+エラーレスポンスもステータスコードとレスポンスボディを持ちます。
+
+```ruby
+request = Pokepay::Request::SendEcho.new(-1)
+
+response = client.send(request)
+# => #<Net::HTTPBadRequest 400 Bad Request readbody=true>
+
+response.code
+# => 400
+
+response.body
+# => {"type"=>"invalid_parameters", "message"=>"Invalid parameters", "errors"=>{"invalid"=>["message"]}}
+```
+<a name="api-operations"></a>
+## API Operations
+
+### Transaction
+- [GetCpmToken](./transaction.md#get-cpm-token): CPMトークンの状態取得
+- [ListTransactions](./transaction.md#list-transactions): 【廃止】取引履歴を取得する
+- [CreateTransaction](./transaction.md#create-transaction): 【廃止】チャージする
+- [ListTransactionsV2](./transaction.md#list-transactions-v2): 取引履歴を取得する
+- [CreateTopupTransaction](./transaction.md#create-topup-transaction): チャージする
+- [CreatePaymentTransaction](./transaction.md#create-payment-transaction): 支払いする
+- [CreateCpmTransaction](./transaction.md#create-cpm-transaction): CPMトークンによる取引作成
+- [CreateTransferTransaction](./transaction.md#create-transfer-transaction): 個人間送金
+- [CreateExchangeTransaction](./transaction.md#create-exchange-transaction): 
+- [GetTransaction](./transaction.md#get-transaction): 取引情報を取得する
+- [RefundTransaction](./transaction.md#refund-transaction): 取引をキャンセルする
+- [GetTransactionByRequestId](./transaction.md#get-transaction-by-request-id): リクエストIDから取引情報を取得する
+- [GetBulkTransaction](./transaction.md#get-bulk-transaction): バルク取引ジョブの実行状況を取得する
+- [ListBulkTransactionJobs](./transaction.md#list-bulk-transaction-jobs): バルク取引ジョブの詳細情報一覧を取得する
+- [RequestUserStats](./transaction.md#request-user-stats): 指定期間内の顧客が行った取引の統計情報をCSVでダウンロードする
+
+### Transfer
+- [GetAccountTransferSummary](./transfer.md#get-account-transfer-summary): 
+- [ListTransfers](./transfer.md#list-transfers): 
+- [ListTransfersV2](./transfer.md#list-transfers-v2): 
+
+### Check
+- [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コードを読み取ることでチャージする
+- [CreateTransactionWithCashtray](./check.md#create-transaction-with-cashtray): CashtrayQRコードを読み取ることで取引する
+
+### Bill
+- [ListBills](./bill.md#list-bills): 支払いQRコード一覧を表示する
+- [CreateBill](./bill.md#create-bill): 支払いQRコードの発行
+- [UpdateBill](./bill.md#update-bill): 支払いQRコードの更新
+
+### Cashtray
+- [CreateCashtray](./cashtray.md#create-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): ウォレット情報を更新する
+- [ListAccountBalances](./customer.md#list-account-balances): エンドユーザーの残高内訳を表示する
+- [ListAccountExpiredBalances](./customer.md#list-account-expired-balances): エンドユーザーの失効済みの残高内訳を表示する
+- [UpdateCustomerAccount](./customer.md#update-customer-account): エンドユーザーのウォレット情報を更新する
+- [GetCustomerAccounts](./customer.md#get-customer-accounts): エンドユーザーのウォレット一覧を表示する
+- [CreateCustomerAccount](./customer.md#create-customer-account): 新規エンドユーザーをウォレットと共に追加する
+- [GetShopAccounts](./customer.md#get-shop-accounts): 店舗ユーザーのウォレット一覧を表示する
+- [ListCustomerTransactions](./customer.md#list-customer-transactions): 取引履歴を取得する
+
+### Organization
+- [ListOrganizations](./organization.md#list-organizations): 加盟店組織の一覧を取得する
+- [CreateOrganization](./organization.md#create-organization): 新規加盟店組織を追加する
+
+### Shop
+- [ListShops](./shop.md#list-shops): 店舗一覧を取得する
+- [CreateShop](./shop.md#create-shop): 【廃止】新規店舗を追加する
+- [CreateShopV2](./shop.md#create-shop-v2): 新規店舗を追加する
+- [GetShop](./shop.md#get-shop): 店舗情報を表示する
+- [UpdateShop](./shop.md#update-shop): 店舗情報を更新する
+
+### User
+
+### Account
+- [ListUserAccounts](./account.md#list-user-accounts): エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+- [CreateUserAccount](./account.md#create-user-account): エンドユーザーのウォレットを作成する
+
+### Private Money
+- [GetPrivateMoneys](./private_money.md#get-private-moneys): マネー一覧を取得する
+- [GetPrivateMoneyOrganizationSummaries](./private_money.md#get-private-money-organization-summaries): 決済加盟店の取引サマリを取得する
+- [GetPrivateMoneySummary](./private_money.md#get-private-money-summary): 取引サマリを取得する
+
+### Bulk
+- [BulkCreateTransaction](./bulk.md#bulk-create-transaction): CSVファイル一括取引
+
+### Event
+- [CreateExternalTransaction](./event.md#create-external-transaction): ポケペイ外部取引を作成する
+- [RefundExternalTransaction](./event.md#refund-external-transaction): ポケペイ外部取引をキャンセルする
+- [GetExternalTransactionByRequestId](./event.md#get-external-transaction-by-request-id): リクエストIDからポケペイ外部取引を取得する
+
+### Campaign
+- [ListCampaigns](./campaign.md#list-campaigns): キャンペーン一覧を取得する
+- [CreateCampaign](./campaign.md#create-campaign): ポイント付与キャンペーンを作る
+- [GetCampaign](./campaign.md#get-campaign): キャンペーンを取得する
+- [UpdateCampaign](./campaign.md#update-campaign): ポイント付与キャンペーンを更新する
+
+### Webhook
+- [ListWebhooks](./webhook.md#list-webhooks): 作成した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): クーポン一覧の取得
+- [CreateCoupon](./coupon.md#create-coupon): クーポンの登録
+- [GetCoupon](./coupon.md#get-coupon): クーポンの取得
+- [UpdateCoupon](./coupon.md#update-coupon): クーポンの更新
+
+### UserDevice
+- [CreateUserDevice](./user_device.md#create-user-device): ユーザーのデバイス登録
+- [GetUserDevice](./user_device.md#get-user-device): ユーザーのデバイスを取得
+- [ActivateUserDevice](./user_device.md#activate-user-device): デバイスの有効化
+
+### BankPay
+- [ListBanks](./bank_pay.md#list-banks): 登録した銀行の一覧
+- [CreateBank](./bank_pay.md#create-bank): 銀行口座の登録
+- [CreateBankTopupTransaction](./bank_pay.md#create-bank-topup-transaction): 銀行からのチャージ
+

data/docs/account.md

@@ -0,0 +1,159 @@
+# Account
+
+<a name="list-user-accounts"></a>
+## ListUserAccounts: エンドユーザー、店舗ユーザーのウォレット一覧を表示する
+ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
+
+```RUBY
+response = $client.send(Pokepay::Request::ListUserAccounts.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_id: ユーザーID
+                          page: 3778,                                           # ページ番号
+                          per_page: 7882                                        # 1ページ分の取引数
+))
+```
+
+
+
+### Parameters
+**`user_id`** 
+  
+
+ユーザーIDです。
+
+指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`page`** 
+  
+
+取得したいページ番号です。デフォルト値は1です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+1ページ当たりのウォレット数です。デフォルト値は50です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+
+
+成功したときは
+[PaginatedAccountDetails](./responses.md#paginated-account-details)
+を返します
+
+
+
+---
+
+
+<a name="create-user-account"></a>
+## CreateUserAccount: エンドユーザーのウォレットを作成する
+既存のエンドユーザーに対して、指定したマネーのウォレットを新規作成します
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateUserAccount.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_id: ユーザーID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          name: "CSoLJdEVZoJB0H5I2jNmYRtpCMs9TezTj3A085y5hWQ3gdeDOWFExGORRYNLJdsZ6n3IGoF44i0499bTqwmusaHN4dAo0kcMwrj6lsuth9pSzmqVAxW3BZh2UFG0NdobuyCqKAyF8XBloHn7nUM7l934bPMQ7DIwFMXGuP", # ウォレット名
+                          external_id: "CrmdUDxKggDF",                          # 外部ID
+                          metadata: "{\"key1\":\"foo\",\"key2\":\"bar\"}"       # ウォレットに付加するメタデータ
+))
+```
+
+
+
+### Parameters
+**`user_id`** 
+  
+
+ユーザーIDです。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`private_money_id`** 
+  
+
+マネーIDです。
+
+作成するウォレットのマネーを指定します。このパラメータは必須です。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`name`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 256
+}
+```
+
+**`external_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 50
+}
+```
+
+**`metadata`** 
+  
+
+ウォレットに付加するメタデータをJSON文字列で指定します。
+指定できるJSON文字列には以下のような制約があります。
+- フラットな構造のJSONを文字列化したものであること。
+- keyは最大32文字の文字列(同じkeyを複数指定することはできません)
+- valueには128文字以下の文字列が指定できます
+
+```json
+{
+  "type": "string",
+  "format": "json"
+}
+```
+
+
+
+成功したときは
+[AccountDetail](./responses.md#account-detail)
+を返します
+
+
+
+---
+
+
+

data/docs/bank_pay.md

@@ -0,0 +1,235 @@
+# BankPay
+BankPayを用いた銀行からのチャージ取引などのAPIを提供しています。
+
+
+<a name="list-banks"></a>
+## ListBanks: 登録した銀行の一覧
+登録した銀行を一覧します
+
+```RUBY
+response = $client.send(Pokepay::Request::ListBanks.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_device_id: デバイス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をユーザーの端末で開き銀行を登録します。
+
+ユーザーが銀行口座の登録に成功すると、callback_urlにリクエストが行われます。
+アプリの場合はDeep Linkを使うことを想定しています。
+
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateBank.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_device_id: デバイスID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          "<Deep Link>",                                        # callback_url: コールバックURL
+                          "ポケペイタロウ",                                            # kana: ユーザーの氏名 (片仮名で指定)
+                          email: "7GsubMGTjI@cOXK.com",                         # ユーザーのメールアドレス
+                          birthdate: "19901142"                                 # 生年月日
+))
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`private_money_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`callback_url`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 256
+}
+```
+
+**`kana`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 30
+}
+```
+
+**`email`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "email",
+  "maxLength": 300
+}
+```
+
+**`birthdate`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "maxLength": 8
+}
+```
+
+
+
+成功したときは
+[BankRegisteringInfo](./responses.md#bank-registering-info)
+を返します
+
+
+
+---
+
+
+<a name="create-bank-topup-transaction"></a>
+## CreateBankTopupTransaction: 銀行からのチャージ
+指定のマネーのアカウントにbank_idの口座を用いてチャージを行います。
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateBankTopupTransaction.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_device_id: デバイスID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # private_money_id: マネーID
+                          3269,                                                 # amount: チャージ金額
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # bank_id: 銀行ID
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # request_id: リクエストID
+))
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`private_money_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`amount`** 
+  
+
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`bank_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`request_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[TransactionDetail](./responses.md#transaction-detail)
+を返します
+
+
+
+---
+
+
+