pokepay_partner_ruby_sdk 0.1.4 → 0.1.5

data/lib/pokepay_partner_ruby_sdk.rb

@@ -8,21 +8,25 @@ require "pokepay_partner_ruby_sdk/response/response"
 require "pokepay_partner_ruby_sdk/request/get_ping"
 require "pokepay_partner_ruby_sdk/request/send_echo"
 require "pokepay_partner_ruby_sdk/request/get_user"
+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/create_customer_account"
+require "pokepay_partner_ruby_sdk/request/list_bills"
 require "pokepay_partner_ruby_sdk/request/create_check"
 require "pokepay_partner_ruby_sdk/request/list_transactions"
 require "pokepay_partner_ruby_sdk/request/create_transaction"
 require "pokepay_partner_ruby_sdk/request/create_topup_transaction"
 require "pokepay_partner_ruby_sdk/request/create_topup_transaction_with_check"
 require "pokepay_partner_ruby_sdk/request/create_payment_transaction"
+require "pokepay_partner_ruby_sdk/request/create_transfer_transaction"
 require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
 require "pokepay_partner_ruby_sdk/request/get_transaction"
 require "pokepay_partner_ruby_sdk/request/refund_transaction"
 require "pokepay_partner_ruby_sdk/request/list_transfers"
 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/response/pong"
@@ -33,6 +37,7 @@ require "pokepay_partner_ruby_sdk/response/account"
 require "pokepay_partner_ruby_sdk/response/account_with_user"
 require "pokepay_partner_ruby_sdk/response/account_detail"
 require "pokepay_partner_ruby_sdk/response/account_balance"
+require "pokepay_partner_ruby_sdk/response/bill"
 require "pokepay_partner_ruby_sdk/response/check"
 require "pokepay_partner_ruby_sdk/response/user"
 require "pokepay_partner_ruby_sdk/response/private_money"
@@ -46,7 +51,10 @@ require "pokepay_partner_ruby_sdk/response/private_money_organization_summary"
 require "pokepay_partner_ruby_sdk/response/paginated_private_money_organization_summaries"
 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_balance"
+require "pokepay_partner_ruby_sdk/response/paginated_shops"
+require "pokepay_partner_ruby_sdk/response/paginated_bills"
 require "pokepay_partner_ruby_sdk/response/bad_request"
 require "pokepay_partner_ruby_sdk/response/partner_client_not_found"
 require "pokepay_partner_ruby_sdk/response/partner_decryption_failed"

data/lib/pokepay_partner_ruby_sdk/request/create_transfer_transaction.rb

@@ -0,0 +1,18 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/transaction"
+
+module Pokepay::Request
+  class CreateTransferTransaction < Request
+    def initialize(sender_id, receiver_id, private_money_id, amount, rest_args = {})
+      @path = "/transactions" + "/transfer"
+      @method = "POST"
+      @body_params = { "sender_id" => sender_id,
+                       "receiver_id" => receiver_id,
+                       "private_money_id" => private_money_id,
+                       "amount" => amount }.merge(rest_args)
+      @response_class = Pokepay::Response::Transaction
+    end
+    attr_reader :response_class
+  end
+end

data/lib/pokepay_partner_ruby_sdk/request/list_bills.rb

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

data/lib/pokepay_partner_ruby_sdk/request/list_shops.rb

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

data/lib/pokepay_partner_ruby_sdk/request/list_user_accounts.rb

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

data/lib/pokepay_partner_ruby_sdk/response/bill.rb

@@ -0,0 +1,24 @@
+# DO NOT EDIT: File is generated by code generator.
+
+require "pokepay_partner_ruby_sdk/response/account_with_user"
+
+module Pokepay::Response
+  class Bill
+    def initialize(row)
+      @id = row["id"]
+      @amount = row["amount"]
+      @max_amount = row["max_amount"]
+      @min_amount = row["min_amount"]
+      @description = row["description"]
+      @account = AccountWithUser.new(row["account"])
+      @is_disabled = row["is_disabled"]
+    end
+    attr_reader :id
+    attr_reader :amount
+    attr_reader :max_amount
+    attr_reader :min_amount
+    attr_reader :description
+    attr_reader :account
+    attr_reader :is_disabled
+  end
+end

data/lib/pokepay_partner_ruby_sdk/response/paginated_accounts.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 PaginatedAccounts
+    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_bills.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 PaginatedBills
+    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_shops.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 PaginatedShops
+    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.4"
+  VERSION = "0.1.5"
 end

data/partner.yaml

@@ -130,6 +130,41 @@ components:
         point_amount:
           type: number
           format: decimal
+    Bill:
+      x-pokepay-schema-type: "response"
+      properties:
+        id:
+          type: string
+          format: uuid
+          summary: 支払いQRコードのID
+        amount:
+          type: number
+          format: decimal
+          nullable: true
+          summary: 支払い額
+          description: 支払い額。支払い額未指定の場合は支払い時に任意金額を入力できます。
+        max_amount:
+          type: number
+          format: decimal
+          nullable: true
+          summary: 支払い額を範囲指定した場合の上限
+          description: 支払い額に任意金額を入力する際の上限です。
+        min_amount:
+          type: number
+          format: decimal
+          nullable: true
+          summary: 支払い額を範囲指定した場合の下限
+          description: 支払い額に任意金額を入力する際の下限です。
+        description:
+          type: string
+          summary: 支払いQRコードの説明文(アプリ上で取引の説明文として表示される)
+        account:
+          $ref: '#/components/schemas/AccountWithUser'
+          summary: 支払いQRコード発行ウォレット
+          description: 支払いQRコードを発行した店舗のウォレットです。ユーザやマネーの情報を含みます。
+        is_disabled:
+          type: boolean
+          summary: 無効化されているかどうか
     Check:
       x-pokepay-schema-type: "response"
       properties:
@@ -293,6 +328,43 @@ components:
         description:
           type: string
           summary: '取引説明文'
+    ShopWithMetadata:
+      x-poepay-schema-type: "response"
+      properties:
+        id:
+          type: string
+          format: uuid
+          summary: 店舗ID
+        name:
+          type: string
+          summary: 店舗名
+        organization_code:
+          type: string
+          maxLength: 256
+          summary: 組織コード
+        postal_code:
+          type: string
+          nullable: true
+          summary: '店舗の郵便番号'
+        address:
+          type: string
+          nullable: true
+          summary: '店舗の住所'
+        tel:
+          type: string
+          nullable: true
+          summary: '店舗の電話番号'
+        email:
+          type: string
+          nullable: true
+          format: email
+          maxLength: 256
+          summary: '店舗のメールアドレス'
+        external_id:
+          type: string
+          nullable: true
+          maxLength: 36
+          summary: '店舗の外部ID'
     UserTransaction:
       x-pokepay-schema-type: "response"
       properties:
@@ -441,6 +513,18 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PaginatedAccounts:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Account'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
     PaginatedAccountBalance:
       x-pokepay-schema-type: "response"
       properties:
@@ -453,6 +537,30 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PaginatedShops:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/ShopWithMetadata'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
+    PaginatedBills:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Bill'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
 
     BadRequest:
       x-pokepay-schema-type: "response"
@@ -630,6 +738,37 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/AdminUserWithShopsAndPrivateMoneys'
+  /users/{user_id}/accounts:
+    get:
+      summary: 'エンドユーザー、店舗ユーザーのウォレット一覧を表示する'
+      description: ユーザーIDを指定してそのユーザーのウォレット一覧を取得します。
+      x-pokepay-operator-name: "ListUserAccounts"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: user_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+          summary: 'ユーザーID'
+          description: |-
+            ユーザーIDです。
+
+            指定したユーザーIDのウォレット一覧を取得します。パートナーキーと紐づく組織が発行しているマネーのウォレットのみが表示されます。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedAccounts'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
   /accounts/{account_id}:
     get:
       summary: 'エンドユーザーのウォレット情報を表示する'
@@ -794,6 +933,103 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+  /bills:
+    get:
+      summary: '支払いQRコード一覧を表示する'
+      description: 支払いQRコード一覧を表示します。
+      x-pokepay-operator-name: "ListBills"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                page:
+                  type: integer
+                  minimum: 1
+                  summary: 'ページ番号'
+                  description: 取得したいページ番号です。
+                per_page:
+                  type: integer
+                  minimum: 1
+                  summary: '1ページの表示数'
+                  description: 1ページに表示する支払いQRコードの数です。
+                bill_id:
+                  type: string
+                  summary: '支払いQRコードのID'
+                  description: 支払いQRコードのIDを指定して検索します。IDは部分一致で検索できます。
+                private_money_id:
+                  type: string
+                  format: uuid
+                  summary: 'マネーID'
+                  description: 支払いQRコードの送金元ウォレットのマネーIDでフィルターします。
+                organization_code:
+                  type: string
+                  pattern: '^[a-zA-Z0-9-]*$'
+                  maxLength: 32
+                  summary: '組織コード'
+                  description: 支払いQRコードの送金元店舗が所属する組織の組織コードでフィルターします。
+                description:
+                  type: string
+                  maxLength: 200
+                  summary: '取引説明文'
+                  description: 支払いQRコードを読み取ることで作られた取引の説明文としてアプリなどに表示されます。
+                  example: 'test bill'
+                created_from:
+                  type: string
+                  format: date-time
+                  summary: '作成日時(起点)'
+                  description: |-
+                    支払いQRコードの作成日時でフィルターします。
+
+                    これ以降に作成された支払いQRコードのみ一覧に表示されます。
+                created_to:
+                  type: string
+                  format: date-time
+                  summary: '作成日時(終点)'
+                  description: |-
+                    支払いQRコードの作成日時でフィルターします。
+
+                    これ以前に作成された支払いQRコードのみ一覧に表示されます。
+                shop_name:
+                  type: string
+                  maxLength: 256
+                  summary: '店舗名'
+                  description: 支払いQRコードを作成した店舗名でフィルターします。
+                  example: 'bill test shop1'
+                shop_id:
+                  type: string
+                  format: uuid
+                  summary: '店舗ID'
+                  description: 支払いQRコードを作成した店舗IDでフィルターします。
+                lower_limit_amount:
+                  type: number
+                  minimum: 0
+                  format: decimal
+                  summary: '金額の範囲によるフィルタ(下限)'
+                  description: 支払いQRコードの金額の下限を指定してフィルターします。
+                upper_limit_amount:
+                  type: number
+                  minimum: 0
+                  format: decimal
+                  summary: '金額の範囲によるフィルタ(上限)'
+                  description: 支払いQRコードの金額の上限を指定してフィルターします。
+                is_disabled:
+                  type: boolean
+                  summary: '支払いQRコードが無効化されているかどうか'
+                  description: 支払いQRコードが無効化されているかどうかを表します。デフォルト値は偽(有効)です。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedBills'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
   /checks:
     post:
       summary: 'チャージQRコードの発行'
@@ -1066,7 +1302,7 @@ paths:
                   format: uuid
                   summary: '店舗ID'
                   description: |-
-                    マネー店舗IDです。
+                    店舗IDです。
 
                     送金元の店舗を指定します。
                 customer_id:
@@ -1181,7 +1417,9 @@ paths:
   /transactions/payment:
     post:
       summary: '支払いする'
-      description: 支払取引を作成します。
+      description: |
+        支払取引を作成します。
+        支払い時には、エンドユーザーの残高のうち、ポイント残高から優先的に消費されます。
       x-pokepay-operator-name: "CreatePaymentTransaction"
       x-pokepay-allow-server-side: true
       requestBody:
@@ -1196,7 +1434,7 @@ paths:
                   format: uuid
                   summary: '店舗ID'
                   description: |-
-                    マネー店舗IDです。
+                    店舗IDです。
 
                     送金先の店舗を指定します。
                 customer_id:
@@ -1245,6 +1483,75 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+  /transactions/transfer:
+    post:
+      summary: '個人間送金'
+      description: |
+        エンドユーザー間での送金取引(個人間送金)を作成します。
+        個人間送金で送れるのはマネーのみで、ポイントを送ることはできません。送金元のマネー残高のうち、有効期限が最も遠いものから順に送金されます。
+      x-pokepay-operator-name: "CreateTransferTransaction"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id", "sender_id", "receiver_id", "amount"]
+              properties:
+                sender_id:
+                  type: string
+                  format: uuid
+                  summary: '送金元ユーザーID'
+                  description: |-
+                    エンドユーザーIDです。
+
+                    送金元のエンドユーザー(送り主)を指定します。
+                receiver_id:
+                  type: string
+                  format: uuid
+                  summary: '受取ユーザーID'
+                  description: |-
+                    エンドユーザーIDです。
+
+                    送金先のエンドユーザー(受け取り人)を指定します。
+                private_money_id:
+                  type: string
+                  format: uuid
+                  summary: 'マネーID'
+                  description: |-
+                    マネーIDです。
+
+                    マネーを指定します。
+                amount:
+                  type: number
+                  minimum: 0
+                  summary: '送金額'
+                  description: |-
+                    マネー額です。
+
+                    送金するマネー額を指定します。
+                description:
+                  type: string
+                  maxLength: 200
+                  summary: '取引履歴に表示する説明文'
+                  description:  |-
+                    取引説明文です。
+
+                    任意入力で、取引履歴に表示される説明文です。
+                  example: たい焼き(小倉)
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Transaction'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
   /transactions/exchange:
     post:
       x-pokepay-allow-server-side: true
@@ -1496,6 +1803,57 @@ paths:
               schema:
                 $ref: '#/components/schemas/Organization'
   /shops:
+    get:
+      summary: '店舗一覧を取得する'
+      x-pokepay-operator-name: "ListShops"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                organization_code:
+                  type: string
+                  pattern: '^[a-zA-Z0-9-]*$'
+                  maxLength: 32
+                  summary: '組織コード'
+                  description: |
+                    このパラメータを渡すとその組織の店舗のみが返され、省略すると加盟店も含む店舗が返されます。
+                  example: 'pocketchange'
+                private_money_id:
+                  type: string
+                  format: uuid
+                  summary: 'マネーID'
+                  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/PaginatedShops'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
     post:
       summary: '新規店舗を追加する'
       x-pokepay-operator-name: "CreateShop"