pokepay_partner_ruby_sdk 0.1.10 → 0.1.14

data/lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb

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

data/lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb

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

data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb

@@ -1,6 +1,6 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/paginated_accounts"
+require "pokepay_partner_ruby_sdk/response/paginated_account_details"
 
 module Pokepay::Request
   class ListUserAccounts < Request
@@ -8,7 +8,7 @@ module Pokepay::Request
       @path = "/users" + "/" + user_id + "/accounts"
       @method = "GET"
       @body_params = {  }
-      @response_class = Pokepay::Response::PaginatedAccounts
+      @response_class = Pokepay::Response::PaginatedAccountDetails
     end
     attr_reader :response_class
   end

data/lib/pokepay_partner_ruby_sdk/request/refund_transaction.rb

@@ -1,6 +1,6 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/transfer"
+require "pokepay_partner_ruby_sdk/response/transaction"
 
 module Pokepay::Request
   class RefundTransaction < Request
@@ -8,7 +8,7 @@ module Pokepay::Request
       @path = "/transactions" + "/" + transaction_id + "/refund"
       @method = "POST"
       @body_params = {  }.merge(rest_args)
-      @response_class = Pokepay::Response::Transfer
+      @response_class = Pokepay::Response::Transaction
     end
     attr_reader :response_class
   end

data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb

@@ -1,6 +1,7 @@
 # DO NOT EDIT: File is generated by code generator.
 
 require "pokepay_partner_ruby_sdk/response/private_money"
+require "pokepay_partner_ruby_sdk/response/user"
 
 module Pokepay::Response
   class AccountDetail
@@ -12,6 +13,7 @@ module Pokepay::Response
       @money_balance = row["money_balance"]
       @point_balance = row["point_balance"]
       @private_money = PrivateMoney.new(row["private_money"])
+      @user = User.new(row["user"])
     end
     attr_reader :id
     attr_reader :name
@@ -20,5 +22,6 @@ module Pokepay::Response
     attr_reader :money_balance
     attr_reader :point_balance
     attr_reader :private_money
+    attr_reader :user
   end
 end

data/lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb

@@ -0,0 +1,16 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/pagination"
+
+module Pokepay::Response
+  class PaginatedAccountDetails
+    def initialize(row)
+      @rows = row["rows"]
+      @count = row["count"]
+      @pagination = Pagination.new(row["pagination"])
+    end
+    attr_reader :rows
+    attr_reader :count
+    attr_reader :pagination
+  end
+end

data/lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb

@@ -0,0 +1,16 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/pagination"
+
+module Pokepay::Response
+  class PaginatedAccountWithUsers
+    def initialize(row)
+      @rows = row["rows"]
+      @count = row["count"]
+      @pagination = Pagination.new(row["pagination"])
+    end
+    attr_reader :rows
+    attr_reader :count
+    attr_reader :pagination
+  end
+end

data/lib/pokepay_partner_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module Pokepay
-  VERSION = "0.1.10"
+  VERSION = "0.1.14"
 end

data/lib/pokepay_partner_ruby_sdk.rb

@@ -13,7 +13,9 @@ 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/get_customer_accounts"
 require "pokepay_partner_ruby_sdk/request/create_customer_account"
+require "pokepay_partner_ruby_sdk/request/get_shop_accounts"
 require "pokepay_partner_ruby_sdk/request/list_bills"
 require "pokepay_partner_ruby_sdk/request/create_bill"
 require "pokepay_partner_ruby_sdk/request/update_bill"
@@ -73,6 +75,8 @@ require "pokepay_partner_ruby_sdk/response/paginated_private_money_organization_
 require "pokepay_partner_ruby_sdk/response/paginated_transaction"
 require "pokepay_partner_ruby_sdk/response/paginated_transfers"
 require "pokepay_partner_ruby_sdk/response/paginated_accounts"
+require "pokepay_partner_ruby_sdk/response/paginated_account_with_users"
+require "pokepay_partner_ruby_sdk/response/paginated_account_details"
 require "pokepay_partner_ruby_sdk/response/paginated_account_balance"
 require "pokepay_partner_ruby_sdk/response/paginated_shops"
 require "pokepay_partner_ruby_sdk/response/paginated_bills"

data/partner.yaml

@@ -145,6 +145,8 @@ components:
           format: decimal
         private_money:
           $ref: '#/components/schemas/PrivateMoney'
+        user:
+          $ref: '#/components/schemas/User'
     ShopAccount:
       x-pokepay-schema-type: "response"
       properties:
@@ -674,7 +676,7 @@ components:
           format: date-time
         type:
           type: string
-          enum: [topup, payment, refund-topup, refund-payment, transfer, exchange-inflow, exchange-outflow]
+          enum: [topup, payment, refund-topup, refund-payment, transfer, exchange-inflow, exchange-outflow, campaign-topup, refund-campaign, use-coupon, refund-coupon]
         description:
           type: string
         transaction_id:
@@ -757,6 +759,30 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PaginatedAccountWithUsers:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/AccountWithUser'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
+    PaginatedAccountDetails:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/AccountDetail'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
     PaginatedAccountBalance:
       x-pokepay-schema-type: "response"
       properties:
@@ -903,6 +929,20 @@ components:
         message:
           type: string
 
+    PrivateMoneyNotAvailable:
+      properties:
+        type:
+          type: string
+          pattern: '^unpermitted_private_money$'
+        message:
+          type: string
+          example: 'This money is not available'
+        object:
+          type: array
+          items:
+            type: string
+            format: uuid
+
   responses:
     BadRequest:
       description: Bad Request
@@ -1008,7 +1048,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/PaginatedAccounts'
+                $ref: '#/components/schemas/PaginatedAccountDetails'
         '400':
           $ref: '#/components/responses/BadRequest'
         '403':
@@ -1219,6 +1259,80 @@ paths:
         '404':
           $ref: '#/components/responses/NotFound'
   /accounts/customers:
+    get:
+      tags:
+        - Customer
+      summary: 'エンドユーザーのウォレット一覧を表示する'
+      description: マネーを指定してエンドユーザーのウォレット一覧を取得します。
+      x-pokepay-operator-name: "GetCustomerAccounts"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+
+                    一覧するウォレットのマネーを指定します。このパラメータは必須です。
+                  type: string
+                  format: uuid
+                page:
+                  type: integer
+                  minimum: 1
+                  title: 'ページ番号'
+                  description: 取得したいページ番号です。デフォルト値は1です。
+                per_page:
+                  type: integer
+                  minimum: 1
+                  title: '1ページ分のウォレット数'
+                  description: 1ページ分のウォレット数です。デフォルト値は30です。
+                created_at_from:
+                  type: string
+                  format: date-time
+                  title: 'ウォレット作成日によるフィルター(開始時点)'
+                  description: ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+                created_at_to:
+                  type: string
+                  format: date-time
+                  title: 'ウォレット作成日によるフィルター(終了時点)'
+                  description: ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+                is_suspended:
+                  type: boolean
+                  title: 'ウォレットが凍結状態かどうかでフィルターする'
+                  description: このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
+                external_id:
+                  type: string
+                  maxLength: 50
+                  title: '外部ID'
+                  description: 外部IDでのフィルタリングです。デフォルトでは未指定です。
+                tel:
+                  type: string
+                  pattern: '^0[0-9]{1,3}-?[0-9]{2,4}-?[0-9]{3,4}$'
+                  title: 'エンドユーザーの電話番号'
+                  description: エンドユーザーの電話番号でのフィルタリングです。デフォルトでは未指定です。
+                email:
+                  type: string
+                  format: email
+                  title: 'エンドユーザーのメールアドレス'
+                  description: エンドユーザーのメールアドレスでのフィルタリングです。デフォルトでは未指定です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedAccountWithUsers'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
     post:
       tags:
         - Customer
@@ -1256,6 +1370,12 @@ paths:
                   type: string
                   maxLength: 256
                   example: ポケペイ太郎のアカウント
+                external_id:
+                  title: '外部ID'
+                  description: |-
+                    PAPIクライアントシステムから利用するPokepayユーザーのIDです。デフォルトでは未指定です。
+                  type: string
+                  maxLength: 50
       responses:
         '200':
           description: OK
@@ -1269,6 +1389,66 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+  /accounts/shops:
+    get:
+      tags:
+        - Customer
+      summary: '店舗ユーザーのウォレット一覧を表示する'
+      description: マネーを指定して店舗ユーザーのウォレット一覧を取得します。
+      x-pokepay-operator-name: "GetShopAccounts"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+
+                    一覧するウォレットのマネーを指定します。このパラメータは必須です。
+                  type: string
+                  format: uuid
+                page:
+                  type: integer
+                  minimum: 1
+                  title: 'ページ番号'
+                  description: 取得したいページ番号です。デフォルト値は1です。
+                per_page:
+                  type: integer
+                  minimum: 1
+                  title: '1ページ分のウォレット数'
+                  description: 1ページ分のウォレット数です。デフォルト値は30です。
+                created_at_from:
+                  type: string
+                  format: date-time
+                  title: 'ウォレット作成日によるフィルター(開始時点)'
+                  description: ウォレット作成日によるフィルターの開始時点のタイムスタンプです。デフォルトでは未指定です。
+                created_at_to:
+                  type: string
+                  format: date-time
+                  title: 'ウォレット作成日によるフィルター(終了時点)'
+                  description: ウォレット作成日によるフィルターの終了時点のタイムスタンプです。デフォルトでは未指定です。
+                is_suspended:
+                  type: boolean
+                  title: 'ウォレットが凍結状態かどうかでフィルターする'
+                  description: このパラメータが指定されている場合、ウォレットの凍結状態で結果がフィルターされます。デフォルトでは未指定です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedAccountWithUsers'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
   /bills:
     get:
       tags:
@@ -1675,6 +1855,15 @@ paths:
                   items:
                     type: string
                     enum: [topup, payment, exchange_outflow, exchange_inflow]
+                description:
+                  type: string
+                  maxLength: 200
+                  title: '取引説明文'
+                  description: |-
+                    取引を指定の取引説明文でフィルターします。
+
+                    取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
+                  example: 店頭QRコードによる支払い
       responses:
         '200':
           description: OK
@@ -1819,6 +2008,17 @@ paths:
 
                     任意入力で、取引履歴に表示される説明文です。
                   example: 初夏のチャージキャンペーン
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+                  description: |-
+                    取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+                    取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+                    リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+                  example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
       responses:
         '200':
           description: OK
@@ -1939,6 +2139,17 @@ paths:
 
                     任意入力で、取引履歴に表示される説明文です。
                   example: たい焼き(小倉)
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+                  description: |-
+                    取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+                    取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+                    リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+                  example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
       responses:
         '200':
           description: OK
@@ -2010,6 +2221,17 @@ paths:
 
                     任意入力で、取引履歴に表示される説明文です。
                   example: たい焼き(小倉)
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+                  description: |-
+                    取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+                    取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+                    リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+                  example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
       responses:
         '200':
           description: OK
@@ -2050,6 +2272,17 @@ paths:
                 description:
                   type: string
                   maxLength: 200
+                request_id:
+                  type: string
+                  format: uuid
+                  title: 'リクエストID'
+                  description: |-
+                    取引作成APIの羃等性を担保するためのリクエスト固有のIDです。
+
+                    取引作成APIで結果が受け取れなかったなどの理由で再試行する際に、二重に取引が作られてしまうことを防ぐために、クライアント側から指定されます。指定は任意で、UUID V4フォーマットでランダム生成した文字列です。リクエストIDは一定期間で削除されます。
+
+                    リクエストIDを指定したとき、まだそのリクエストIDに対する取引がない場合、新規に取引が作られレスポンスとして返されます。もしそのリクエストIDに対する取引が既にある場合、既存の取引がレスポンスとして返されます。
+                  example: '9dbfd997-b948-40d3-a3bf-6bc1a01368d2'
       responses:
         '200':
           description: OK
@@ -2171,8 +2404,9 @@ paths:
     post:
       tags:
         - Transaction
-      summary: 返金する
-      x-pokepay-operator-name: RefundTransaction
+      summary: '返金する'
+      x-pokepay-operator-name: "RefundTransaction"
+      x-pokepay-allow-server-side: true
       parameters:
         - in: path
           name: transaction_id
@@ -2198,11 +2432,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Transfer'
+                $ref: '#/components/schemas/Transaction'
         '403':
           $ref: '#/components/responses/Forbidden'
-        '404':
-          $ref: '#/components/responses/NotFound'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
   /transfers:
@@ -2256,9 +2488,37 @@ paths:
                     enum: [topup, payment, transfer, exchange]
                 transfer_types:
                   type: array
+                  description: |-
+                    取引明細の種類でフィルターします。
+
+                    以下の種類を指定できます。
+
+                    1. topup
+                    店舗からエンドユーザーへの送金取引(チャージ)、またはそのキャンセル取引
+
+                    2. payment
+                    エンドユーザーから店舗への送金取引(支払い)、またはそのキャンセル取引
+
+                    3. exchange
+                    他マネーへの流出/流入
+
+                    4. campaign
+                    取引に対するポイント還元キャンペーンによるポイント付与、またはそのキャンセル取引
+
+                    5. coupon
+                    クーポンによる値引き処理、またはそのキャンセル取引
                   items:
                     type: string
-                    enum: [topup, payment, exchange, transfer]
+                    enum: [topup, payment, exchange, transfer, coupon, campaign]
+                description:
+                  type: string
+                  maxLength: 200
+                  title: '取引詳細説明文'
+                  description: |-
+                    取引詳細を指定の取引詳細説明文でフィルターします。
+
+                    取引詳細説明文が完全一致する取引のみ抽出されます。取引詳細説明文は最大200文字で記録されています。
+                  example: 店頭QRコードによる支払い
       responses:
         '200':
           description: OK
@@ -2604,7 +2864,13 @@ paths:
         '409':
           $ref: '#/components/responses/Conflict'
         '422':
-          $ref: '#/components/responses/UnprocessableEntity'
+          description:
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '#/components/schemas/PrivateMoneyNotAvailable'
+                  - $ref: '#/components/schemas/UnprocessableEntity'
   /shops/{shop_id}:
     get:
       tags:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pokepay_partner_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.14
 platform: ruby
 authors:
 - Pocket Change, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -134,10 +134,12 @@ files:
 - lib/pokepay_partner_ruby_sdk/request/get_account.rb
 - lib/pokepay_partner_ruby_sdk/request/get_bulk_transaction.rb
 - lib/pokepay_partner_ruby_sdk/request/get_cashtray.rb
+- lib/pokepay_partner_ruby_sdk/request/get_customer_accounts.rb
 - lib/pokepay_partner_ruby_sdk/request/get_ping.rb
 - lib/pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries.rb
 - lib/pokepay_partner_ruby_sdk/request/get_private_moneys.rb
 - lib/pokepay_partner_ruby_sdk/request/get_shop.rb
+- lib/pokepay_partner_ruby_sdk/request/get_shop_accounts.rb
 - 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
@@ -173,6 +175,8 @@ files:
 - lib/pokepay_partner_ruby_sdk/response/organization.rb
 - lib/pokepay_partner_ruby_sdk/response/organization_summary.rb
 - lib/pokepay_partner_ruby_sdk/response/paginated_account_balance.rb
+- lib/pokepay_partner_ruby_sdk/response/paginated_account_details.rb
+- lib/pokepay_partner_ruby_sdk/response/paginated_account_with_users.rb
 - lib/pokepay_partner_ruby_sdk/response/paginated_accounts.rb
 - lib/pokepay_partner_ruby_sdk/response/paginated_bills.rb
 - lib/pokepay_partner_ruby_sdk/response/paginated_private_money_organization_summaries.rb