pokepay_partner_ruby_sdk 0.3.2 → 0.3.6

data/docs/user_device.md

@@ -0,0 +1,134 @@
+# UserDevice
+UserDeviceはユーザー毎のデバイスを管理します。
+あるユーザーが使っている端末を区別する必要がある場合に用いられます。
+これが必要な理由はBank Payを用いたチャージを行う場合は端末を区別できることが要件としてあるためです。
+
+
+<a name="create-user-device"></a>
+## CreateUserDevice: ユーザーのデバイス登録
+ユーザーのデバイスを新規に登録します
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateUserDevice.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # user_id: ユーザーID
+                          metadata: "{\"user_agent\": \"Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:120.0) Gecko/20100101 Firefox/120.0\"}" # ユーザーデバイスのメタデータ
+))
+```
+
+
+
+### Parameters
+**`user_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`metadata`** 
+  
+
+ユーザーのデバイス用の情報をメタデータを保持するために用います。
+例: 端末の固有情報やブラウザのUser-Agent
+
+
+```json
+{
+  "type": "string",
+  "format": "json"
+}
+```
+
+
+
+成功したときは
+[UserDevice](./responses.md#user-device)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|422|user_not_found||The user is not found|
+
+
+
+---
+
+
+<a name="get-user-device"></a>
+## GetUserDevice: ユーザーのデバイスを取得
+ユーザーのデバイスの情報を取得します
+
+```RUBY
+response = $client.send(Pokepay::Request::GetUserDevice.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # user_device_id: ユーザーデバイスID
+))
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[UserDevice](./responses.md#user-device)
+を返します
+
+
+
+---
+
+
+<a name="activate-user-device"></a>
+## ActivateUserDevice: デバイスの有効化
+指定のデバイスを有効化し、それ以外の同一ユーザーのデバイスを無効化します。
+
+
+```RUBY
+response = $client.send(Pokepay::Request::ActivateUserDevice.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # user_device_id: ユーザーデバイスID
+))
+```
+
+
+
+### Parameters
+**`user_device_id`** 
+  
+
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[UserDevice](./responses.md#user-device)
+を返します
+
+
+
+---
+
+
+

data/docs/webhook.md

@@ -0,0 +1,231 @@
+# Webhook
+Webhookは特定のワーカータスクでの処理が完了した事を通知します。
+WebHookにはURLとタスク名、有効化されているかを設定することが出来ます。
+通知はタスク完了時、事前に設定したURLにPOSTリクエストを行います。
+
+
+<a name="list-webhooks"></a>
+## ListWebhooks: 作成したWebhookの一覧を返す
+
+```RUBY
+response = $client.send(Pokepay::Request::ListWebhooks.new(
+                          page: 1,                                              # ページ番号
+                          per_page: 50                                          # 1ページ分の取得数
+))
+```
+
+
+
+### Parameters
+**`page`** 
+  
+
+取得したいページ番号です。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+**`per_page`** 
+  
+
+1ページ分の取得数です。デフォルトでは 50 になっています。
+
+```json
+{
+  "type": "integer",
+  "minimum": 1
+}
+```
+
+
+
+成功したときは
+[PaginatedOrganizationWorkerTaskWebhook](./responses.md#paginated-organization-worker-task-webhook)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+
+
+
+---
+
+
+<a name="create-webhook"></a>
+## CreateWebhook: webhookの作成
+ワーカータスクの処理が終了したことを通知するためのWebhookを登録します
+このAPIにより指定したタスクの終了時に、指定したURLにPOSTリクエストを送信します。
+このとき、リクエストボディは `{"task": <タスク名>}` という値になります。
+
+```RUBY
+response = $client.send(Pokepay::Request::CreateWebhook.new(
+                          "process_user_stats_operation",                       # task: タスク名
+                          "m4tM4"                                               # url: URL
+))
+```
+
+
+
+### Parameters
+**`task`** 
+  
+
+ワーカータスク名を指定します
+
+```json
+{
+  "type": "string",
+  "enum": [
+    "bulk_shops",
+    "process_user_stats_operation"
+  ]
+}
+```
+
+**`url`** 
+  
+
+通知先のURLを指定します
+
+```json
+{
+  "type": "string"
+}
+```
+
+
+
+成功したときは
+[OrganizationWorkerTaskWebhook](./responses.md#organization-worker-task-webhook)
+を返します
+
+### Error Responses
+|status|type|ja|en|
+|---|---|---|---|
+|403|unpermitted_admin_user|この管理ユーザには権限がありません|Admin does not have permission|
+|409|organization_worker_task_finish_webhook_conflict|そのwebhookは既に登録されています|The webhook is already registered|
+
+
+
+---
+
+
+<a name="delete-webhook"></a>
+## DeleteWebhook: Webhookの削除
+指定したWebhookを削除します
+
+```RUBY
+response = $client.send(Pokepay::Request::DeleteWebhook.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"                # webhook_id: Webhook ID
+))
+```
+
+
+
+### Parameters
+**`webhook_id`** 
+  
+
+削除するWebhookのIDです。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+
+
+成功したときは
+[OrganizationWorkerTaskWebhook](./responses.md#organization-worker-task-webhook)
+を返します
+
+
+
+---
+
+
+<a name="update-webhook"></a>
+## UpdateWebhook: Webhookの更新
+指定したWebhookの内容を更新します
+
+```RUBY
+response = $client.send(Pokepay::Request::UpdateWebhook.new(
+                          "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",               # webhook_id: Webhook ID
+                          url: "rQ7TMW",                                        # URL
+                          is_active: true,                                      # 有効/無効
+                          task: "bulk_shops"                                    # タスク名
+))
+```
+
+
+
+### Parameters
+**`webhook_id`** 
+  
+
+更新するWebhookのIDです。
+
+```json
+{
+  "type": "string",
+  "format": "uuid"
+}
+```
+
+**`url`** 
+  
+
+変更するURLを指定します
+
+```json
+{
+  "type": "string"
+}
+```
+
+**`is_active`** 
+  
+
+trueならWebhookによる通知が有効になり、falseなら無効になります
+
+```json
+{
+  "type": "boolean"
+}
+```
+
+**`task`** 
+  
+
+指定したタスクが終了したときにWebhookによる通知がされます
+
+```json
+{
+  "type": "string",
+  "enum": [
+    "bulk_shops",
+    "process_user_stats_operation"
+  ]
+}
+```
+
+
+
+成功したときは
+[OrganizationWorkerTaskWebhook](./responses.md#organization-worker-task-webhook)
+を返します
+
+
+
+---
+
+
+

data/lib/pokepay_partner_ruby_sdk/request/activate_user_device.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/user_device"
+
+module Pokepay::Request
+  class ActivateUserDevice < Request
+    def initialize(user_device_id)
+      @path = "/user-devices" + "/" + user_device_id + "/activate"
+      @method = "POST"
+      @body_params = {  }
+      @response_class = Pokepay::Response::UserDevice
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/create_bank.rb

@@ -0,0 +1,17 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/bank_registering_info"
+
+module Pokepay::Request
+  class CreateBank < Request
+    def initialize(user_device_id, private_money_id, callback_url, kana, rest_args = {})
+      @path = "/user-devices" + "/" + user_device_id + "/banks"
+      @method = "POST"
+      @body_params = { "private_money_id" => private_money_id,
+                       "callback_url" => callback_url,
+                       "kana" => kana }.merge(rest_args)
+      @response_class = Pokepay::Response::BankRegisteringInfo
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/create_bank_topup_transaction.rb

@@ -0,0 +1,18 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/transaction_detail"
+
+module Pokepay::Request
+  class CreateBankTopupTransaction < Request
+    def initialize(user_device_id, private_money_id, amount, bank_id, request_id)
+      @path = "/user-devices" + "/" + user_device_id + "/banks" + "/topup"
+      @method = "POST"
+      @body_params = { "private_money_id" => private_money_id,
+                       "amount" => amount,
+                       "bank_id" => bank_id,
+                       "request_id" => request_id }
+      @response_class = Pokepay::Response::TransactionDetail
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/create_coupon.rb

@@ -0,0 +1,19 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/coupon_detail"
+
+module Pokepay::Request
+  class CreateCoupon < Request
+    def initialize(private_money_id, name, starts_at, ends_at, issued_shop_id, rest_args = {})
+      @path = "/coupons"
+      @method = "POST"
+      @body_params = { "private_money_id" => private_money_id,
+                       "name" => name,
+                       "starts_at" => starts_at,
+                       "ends_at" => ends_at,
+                       "issued_shop_id" => issued_shop_id }.merge(rest_args)
+      @response_class = Pokepay::Response::CouponDetail
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/create_external_transaction.rb

@@ -1,6 +1,6 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/external_transaction"
+require "pokepay_partner_ruby_sdk/response/external_transaction_detail"
 
 module Pokepay::Request
   class CreateExternalTransaction < Request
@@ -11,7 +11,7 @@ module Pokepay::Request
                        "customer_id" => customer_id,
                        "private_money_id" => private_money_id,
                        "amount" => amount }.merge(rest_args)
-      @response_class = Pokepay::Response::ExternalTransaction
+      @response_class = Pokepay::Response::ExternalTransactionDetail
     end
     attr_reader :response_class
   end

data/lib/pokepay_partner_ruby_sdk/request/create_transaction_with_cashtray.rb

@@ -0,0 +1,16 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/transaction_detail"
+
+module Pokepay::Request
+  class CreateTransactionWithCashtray < Request
+    def initialize(cashtray_id, customer_id, rest_args = {})
+      @path = "/transactions" + "/cashtray"
+      @method = "POST"
+      @body_params = { "cashtray_id" => cashtray_id,
+                       "customer_id" => customer_id }.merge(rest_args)
+      @response_class = Pokepay::Response::TransactionDetail
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/create_user_device.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/user_device"
+
+module Pokepay::Request
+  class CreateUserDevice < Request
+    def initialize(user_id, rest_args = {})
+      @path = "/user-devices"
+      @method = "POST"
+      @body_params = { "user_id" => user_id }.merge(rest_args)
+      @response_class = Pokepay::Response::UserDevice
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/delete_webhook.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/organization_worker_task_webhook"
+
+module Pokepay::Request
+  class DeleteWebhook < Request
+    def initialize(webhook_id)
+      @path = "/webhooks" + "/" + webhook_id
+      @method = "DELETE"
+      @body_params = {  }
+      @response_class = Pokepay::Response::OrganizationWorkerTaskWebhook
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/get_check.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/check"
+
+module Pokepay::Request
+  class GetCheck < Request
+    def initialize(check_id)
+      @path = "/checks" + "/" + check_id
+      @method = "GET"
+      @body_params = {  }
+      @response_class = Pokepay::Response::Check
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/get_coupon.rb

@@ -5,7 +5,7 @@ require "pokepay_partner_ruby_sdk/response/coupon_detail"
 module Pokepay::Request
   class GetCoupon < Request
     def initialize(coupon_id)
-      @path = "/coupons" + "/" + coupon-id
+      @path = "/coupons" + "/" + coupon_id
       @method = "GET"
       @body_params = {  }
       @response_class = Pokepay::Response::CouponDetail

data/lib/pokepay_partner_ruby_sdk/request/get_external_transaction_by_request_id.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/external_transaction_detail"
+
+module Pokepay::Request
+  class GetExternalTransactionByRequestId < Request
+    def initialize(request_id)
+      @path = "/external-transactions" + "/requests" + "/" + request_id
+      @method = "GET"
+      @body_params = {  }
+      @response_class = Pokepay::Response::ExternalTransactionDetail
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/get_user_device.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/user_device"
+
+module Pokepay::Request
+  class GetUserDevice < Request
+    def initialize(user_device_id)
+      @path = "/user-devices" + "/" + user_device_id
+      @method = "GET"
+      @body_params = {  }
+      @response_class = Pokepay::Response::UserDevice
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/list_banks.rb

@@ -0,0 +1,15 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/banks"
+
+module Pokepay::Request
+  class ListBanks < Request
+    def initialize(user_device_id, rest_args = {})
+      @path = "/user-devices" + "/" + user_device_id + "/banks"
+      @method = "GET"
+      @body_params = {  }.merge(rest_args)
+      @response_class = Pokepay::Response::Banks
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/list_checks.rb

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

data/lib/pokepay_partner_ruby_sdk/request/list_organizations.rb

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

data/lib/pokepay_partner_ruby_sdk/request/refund_external_transaction.rb

@@ -1,6 +1,6 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/external_transaction"
+require "pokepay_partner_ruby_sdk/response/external_transaction_detail"
 
 module Pokepay::Request
   class RefundExternalTransaction < Request
@@ -8,7 +8,7 @@ module Pokepay::Request
       @path = "/external-transactions" + "/" + event_id + "/refund"
       @method = "POST"
       @body_params = {  }.merge(rest_args)
-      @response_class = Pokepay::Response::ExternalTransaction
+      @response_class = Pokepay::Response::ExternalTransactionDetail
     end
     attr_reader :response_class
   end

data/lib/pokepay_partner_ruby_sdk/request/update_check.rb

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

data/lib/pokepay_partner_ruby_sdk/request/update_coupon.rb

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