pokepay_partner_ruby_sdk 0.1.19 → 0.2.0

data/lib/pokepay_partner_ruby_sdk/request/get_private_money_summary.rb

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

data/lib/pokepay_partner_ruby_sdk/request/get_transaction_by_request_id.rb

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

data/lib/pokepay_partner_ruby_sdk/request/list_transactions_v2.rb

@@ -4,10 +4,10 @@ require "pokepay_partner_ruby_sdk/response/paginated_transaction_v2"
 
 module Pokepay::Request
   class ListTransactionsV2 < Request
-    def initialize(private_money_id, rest_args = {})
+    def initialize(rest_args = {})
       @path = "/transactions-v2"
       @method = "GET"
-      @body_params = { "private_money_id" => private_money_id }.merge(rest_args)
+      @body_params = {  }.merge(rest_args)
       @response_class = Pokepay::Response::PaginatedTransactionV2
     end
     attr_reader :response_class

data/lib/pokepay_partner_ruby_sdk/response/account.rb

@@ -1,6 +1,5 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/account_status"
 require "pokepay_partner_ruby_sdk/response/private_money"
 
 module Pokepay::Response
@@ -9,7 +8,7 @@ module Pokepay::Response
       @id = row["id"]
       @name = row["name"]
       @is_suspended = row["is_suspended"]
-      @status = AccountStatus.new(row["status"])
+      @status = row["status"]
       @private_money = PrivateMoney.new(row["private_money"])
     end
     attr_reader :id

data/lib/pokepay_partner_ruby_sdk/response/account_detail.rb

@@ -1,6 +1,5 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/account_status"
 require "pokepay_partner_ruby_sdk/response/private_money"
 require "pokepay_partner_ruby_sdk/response/user"
 
@@ -10,7 +9,7 @@ module Pokepay::Response
       @id = row["id"]
       @name = row["name"]
       @is_suspended = row["is_suspended"]
-      @status = AccountStatus.new(row["status"])
+      @status = row["status"]
       @balance = row["balance"]
       @money_balance = row["money_balance"]
       @point_balance = row["point_balance"]

data/lib/pokepay_partner_ruby_sdk/response/account_with_user.rb

@@ -1,6 +1,5 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/account_status"
 require "pokepay_partner_ruby_sdk/response/private_money"
 require "pokepay_partner_ruby_sdk/response/user"
 
@@ -10,7 +9,7 @@ module Pokepay::Response
       @id = row["id"]
       @name = row["name"]
       @is_suspended = row["is_suspended"]
-      @status = AccountStatus.new(row["status"])
+      @status = row["status"]
       @private_money = PrivateMoney.new(row["private_money"])
       @user = User.new(row["user"])
     end

data/lib/pokepay_partner_ruby_sdk/response/account_without_private_money_detail.rb

@@ -1,6 +1,5 @@
 # DO NOT EDIT: File is generated by code generator.
 
-require "pokepay_partner_ruby_sdk/response/account_status"
 require "pokepay_partner_ruby_sdk/response/user"
 
 module Pokepay::Response
@@ -9,7 +8,7 @@ module Pokepay::Response
       @id = row["id"]
       @name = row["name"]
       @is_suspended = row["is_suspended"]
-      @status = AccountStatus.new(row["status"])
+      @status = row["status"]
       @private_money_id = row["private_money_id"]
       @user = User.new(row["user"])
     end

data/lib/pokepay_partner_ruby_sdk/response/private_money_summary.rb

@@ -0,0 +1,27 @@
+# DO NOT EDIT: File is generated by code generator.
+
+
+module Pokepay::Response
+  class PrivateMoneySummary
+    def initialize(row)
+      @topup_amount = row["topup_amount"]
+      @refunded_topup_amount = row["refunded_topup_amount"]
+      @payment_amount = row["payment_amount"]
+      @refunded_payment_amount = row["refunded_payment_amount"]
+      @added_point_amount = row["added_point_amount"]
+      @refunded_added_point_amount = row["refunded_added_point_amount"]
+      @exchange_inflow_amount = row["exchange_inflow_amount"]
+      @exchange_outflow_amount = row["exchange_outflow_amount"]
+      @transaction_count = row["transaction_count"]
+    end
+    attr_reader :topup_amount
+    attr_reader :refunded_topup_amount
+    attr_reader :payment_amount
+    attr_reader :refunded_payment_amount
+    attr_reader :added_point_amount
+    attr_reader :refunded_added_point_amount
+    attr_reader :exchange_inflow_amount
+    attr_reader :exchange_outflow_amount
+    attr_reader :transaction_count
+  end
+end

data/lib/pokepay_partner_ruby_sdk/version.rb

@@ -1,3 +1,3 @@
 module Pokepay
-  VERSION = "0.1.19"
+  VERSION = "0.2.0"
 end

data/lib/pokepay_partner_ruby_sdk.rb

@@ -36,6 +36,7 @@ require "pokepay_partner_ruby_sdk/request/create_exchange_transaction"
 require "pokepay_partner_ruby_sdk/request/bulk_create_transaction"
 require "pokepay_partner_ruby_sdk/request/get_transaction"
 require "pokepay_partner_ruby_sdk/request/refund_transaction"
+require "pokepay_partner_ruby_sdk/request/get_transaction_by_request_id"
 require "pokepay_partner_ruby_sdk/request/create_external_transaction"
 require "pokepay_partner_ruby_sdk/request/refund_external_transaction"
 require "pokepay_partner_ruby_sdk/request/list_transfers"
@@ -47,6 +48,7 @@ require "pokepay_partner_ruby_sdk/request/get_shop"
 require "pokepay_partner_ruby_sdk/request/update_shop"
 require "pokepay_partner_ruby_sdk/request/get_private_moneys"
 require "pokepay_partner_ruby_sdk/request/get_private_money_organization_summaries"
+require "pokepay_partner_ruby_sdk/request/get_private_money_summary"
 require "pokepay_partner_ruby_sdk/request/list_customer_transactions"
 require "pokepay_partner_ruby_sdk/request/get_bulk_transaction"
 require "pokepay_partner_ruby_sdk/request/create_cashtray"
@@ -61,7 +63,6 @@ require "pokepay_partner_ruby_sdk/response/pong"
 require "pokepay_partner_ruby_sdk/response/echo"
 require "pokepay_partner_ruby_sdk/response/pagination"
 require "pokepay_partner_ruby_sdk/response/admin_user_with_shops_and_private_moneys"
-require "pokepay_partner_ruby_sdk/response/account_status"
 require "pokepay_partner_ruby_sdk/response/account"
 require "pokepay_partner_ruby_sdk/response/account_with_user"
 require "pokepay_partner_ruby_sdk/response/account_detail"
@@ -90,6 +91,7 @@ require "pokepay_partner_ruby_sdk/response/product"
 require "pokepay_partner_ruby_sdk/response/organization_summary"
 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/private_money_summary"
 require "pokepay_partner_ruby_sdk/response/paginated_transaction"
 require "pokepay_partner_ruby_sdk/response/paginated_transaction_v2"
 require "pokepay_partner_ruby_sdk/response/paginated_transfers"

data/partner.yaml

@@ -96,11 +96,6 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/PrivateMoney'
-    AccountStatus:
-      x-pokepay-schema-type: "response"
-      type: string
-      enum: [active, suspended, pre-closed, closed]
-      title: 'ウォレット状態'
     Account:
       x-pokepay-schema-type: "response"
       properties:
@@ -115,7 +110,8 @@ components:
           type: boolean
           title: 'ウォレットが凍結されているかどうか'
         status:
-          $ref: '#/components/schemas/AccountStatus'
+          type: string
+          enum: [active, suspended, pre-closed, closed]
         private_money:
           $ref: '#/components/schemas/PrivateMoney'
           title: '設定マネー情報'
@@ -130,7 +126,8 @@ components:
         is_suspended:
           type: boolean
         status:
-          $ref: '#/components/schemas/AccountStatus'
+          type: string
+          enum: [active, suspended, pre-closed, closed]
         private_money:
           $ref: '#/components/schemas/PrivateMoney'
         user:
@@ -146,7 +143,8 @@ components:
         is_suspended:
           type: boolean
         status:
-          $ref: '#/components/schemas/AccountStatus'
+          type: string
+          enum: [active, suspended, pre-closed, closed]
         balance:
           type: number
           format: decimal
@@ -747,7 +745,8 @@ components:
         is_suspended:
           type: boolean
         status:
-          $ref: '#/components/schemas/AccountStatus'
+          type: string
+          enum: [active, suspended, pre-closed, closed]
         private_money_id:
           type: string
           format: uuid
@@ -780,7 +779,7 @@ components:
           format: date-time
         type:
           type: string
-          enum: [topup, payment, refund-topup, refund-payment, transfer, exchange-inflow, exchange-outflow, campaign-topup, refund-campaign, use-coupon, refund-coupon, cashback, expire]
+          enum: [topup, payment, refund-topup, refund-payment, transfer, exchange-inflow, exchange-outflow, refund-exchange-inflow, refund-exchange-outflow, campaign-topup, refund-campaign, use-coupon, refund-coupon, cashback, expire]
         description:
           type: string
         transaction_id:
@@ -879,6 +878,35 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PrivateMoneySummary:
+      x-pokepay-schema-type: "response"
+      properties:
+        topup_amount:
+          type: number
+          format: decimal
+        refunded_topup_amount:
+          type: number
+          format: decimal
+        payment_amount:
+          type: number
+          format: decimal
+        refunded_payment_amount:
+          type: number
+          format: decimal
+        added_point_amount:
+          type: number
+          format: decimal
+        refunded_added_point_amount:
+          type: number
+          format: decimal
+        exchange_inflow_amount:
+          type: number
+          format: decimal
+        exchange_outflow_amount:
+          type: number
+          format: decimal
+        transaction_count:
+          type: integer
     PaginatedTransaction:
       x-pokepay-schema-type: "response"
       properties:
@@ -2094,7 +2122,6 @@ paths:
         - Check
       summary: 'チャージQRコードの発行'
       x-pokepay-operator-name: "CreateCheck"
-      x-pokepay-allow-server-side: true
       requestBody:
         required: true
         content:
@@ -2197,7 +2224,7 @@ paths:
     get:
       tags:
         - Transaction
-      summary: '取引履歴を取得する'
+      summary: '【廃止】取引履歴を取得する'
       description: 取引一覧を返します。
       x-pokepay-operator-name: "ListTransactions"
       x-pokepay-allow-server-side: true
@@ -2270,12 +2297,11 @@ paths:
                     フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
                 transaction_id:
                   type: string
-                  format: uuid
                   title: '取引ID'
                   description: |-
                     取引IDです。
 
-                    フィルターとして使われ、指定された取引のみ一覧に表示されます。
+                    フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
                 organization_code:
                   type: string
                   pattern: '^[a-zA-Z0-9-]*$'
@@ -2352,7 +2378,7 @@ paths:
     post:
       tags:
         - Transaction
-      summary: 'チャージする(廃止予定)'
+      summary: '【廃止】チャージする'
       description: |-
         チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
       x-pokepay-operator-name: "CreateTransaction"
@@ -2418,7 +2444,6 @@ paths:
         content:
           application/json:
             schema:
-              required: ["private_money_id"]
               properties:
                 private_money_id:
                   type: string
@@ -2436,7 +2461,7 @@ paths:
                   description: |-
                     組織コードです。
 
-                    フィルターとして使われ、指定された組織での取引のみ一覧に表示されます。
+                    フィルターとして使われ、指定された組織の店舗での取引のみ一覧に表示されます。
                   example: 'pocketchange'
                 shop_id:
                   type: string
@@ -2444,7 +2469,7 @@ paths:
                   title: '店舗ID'
                   description: |-
                     店舗IDです。
-                    
+
                     フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
                 terminal_id:
                   type: string
@@ -2461,7 +2486,7 @@ paths:
                   description: |-
                     エンドユーザーIDです。
 
-                    フィルターとして使われ、指定されたエンドユーザーでの取引のみ一覧に表示されます。
+                    フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
                 customer_name:
                   type: string
                   maxLength: 256
@@ -2482,12 +2507,11 @@ paths:
                   example: 店頭QRコードによる支払い
                 transaction_id:
                   type: string
-                  format: uuid
                   title: '取引ID'
                   description: |-
                     取引IDです。
 
-                    フィルターとして使われ、指定された取引のみ一覧に表示されます。
+                    フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
                 is_modified:
                   type: boolean
                   title: 'キャンセルフラグ'
@@ -2513,15 +2537,22 @@ paths:
 
                     3. exchange-outflow
                        他マネーへの流出
+                       private_money_idが指定されたとき、そのマネーから見て流出方向の交換取引が抽出されます。
+                       private_money_idを省略した場合は表示されません。
 
                     4. exchange-inflow
                        他マネーからの流入
+                       private_money_idが指定されたとき、そのマネーから見て流入方向の交換取引が抽出されます。
+                       private_money_idを省略した場合は表示されません。
 
                     5. cashback
                        退会時返金取引
+
+                    6. expire
+                       退会時失効取引
                   items:
                     type: string
-                    enum: [topup, payment, exchange_outflow, exchange_inflow, cashback]
+                    enum: [topup, payment, exchange_outflow, exchange_inflow, cashback, expire]
                 from:
                   type: string
                   format: date-time
@@ -2541,23 +2572,28 @@ paths:
                 next_page_cursor_id:
                   type: string
                   format: uuid
-                  title: '次のページへ遷移する際に起点となるtransactionのuuid'
+                  title: '次ページへ遷移する際に起点となるtransactionのID'
                   description: |-
-                    次のページへ遷移する際に起点となるtransactionのuuid(前のページの末尾の要素のuuid)です。
+                    次ページへ遷移する際に起点となるtransactionのID(前ページの末尾要素のID)です。
+                    本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
+                    UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
 
-                    prev_page_cursor_idのtransaction自体は次のページには含まれない。
+                    next_page_cursor_idのtransaction自体は次のページには含まれません。
                 prev_page_cursor_id:
                   type: string
                   format: uuid
-                  title: '前のページへ遷移する際に起点となるtransactionのuuid'
+                  title: '前ページへ遷移する際に起点となるtransactionのID'
                   description: |-
-                    前のページへ遷移する際に起点となるtransactionのuuid(次のページの先頭の要素のuuid)です。
+                    前ページへ遷移する際に起点となるtransactionのID(次ページの先頭要素のID)です。
+
+                    本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
+                    UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
 
-                    next_page_cursor_idのtransaction自体は前のページには含まれない。
+                    prev_page_cursor_idのtransaction自体は前のページには含まれません。
                 per_page:
                   type: integer
                   minimum: 1
-                  maximum: 100
+                  maximum: 1000
                   title: '1ページ分の取引数'
                   description: |-
                     1ページ分の取引数です。
@@ -3342,6 +3378,39 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+  /transactions/requests/{request_id}:
+    get:
+      tags:
+        - Transaction
+      summary: 'リクエストIDから取引情報を取得する'
+      description: 取引を取得します。
+      x-pokepay-operator-name: "GetTransactionByRequestId"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: request_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'リクエストID'
+          description: |-
+            取引作成時にクライアントが生成し指定するリクエストIDです。
+
+            リクエストIDに対応する取引が存在すればその取引を返し、無ければNotFound(404)を返します。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TransactionDetail'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
   /external-transactions:
     post:
       tags:
@@ -3803,7 +3872,7 @@ paths:
     post:
       tags:
         - Shop
-      summary: '新規店舗を追加する(廃止予定)'
+      summary: '【廃止】新規店舗を追加する'
       description: |-
         新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
       x-pokepay-operator-name: "CreateShop"
@@ -4200,6 +4269,50 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '404':
           $ref: '#/components/responses/NotFound'
+  /private-moneys/{private_money_id}/summary:
+    get:
+      tags:
+        - Private Money
+      summary: 取引サマリを取得する
+      x-pokepay-operator-name: "GetPrivateMoneySummary"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                from:
+                  type: string
+                  format: date-time
+                  title: '開始日時'
+                to:
+                  type: string
+                  format: date-time
+                  title: '終了日時'
+      parameters:
+        - in: path
+          name: private_money_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: マネーID
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PrivateMoneySummary'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
   /customers/transactions:
     get:
       tags:
@@ -5109,6 +5222,13 @@ paths:
                     マネーIDです。
 
                     フィルターとして使われ、指定したマネーでのキャンペーンのみ一覧に表示されます。
+                is_ongoing:
+                  type: boolean
+                  title: '現在適用可能なキャンペーンかどうか'
+                  description: |-
+                    有効化されており、現在キャンペーン期間内にあるキャンペーンをフィルターするために使われます。
+                    真であれば適用可能なもののみを抽出し、偽であれば適用不可なもののみを抽出します。
+                    デフォルトでは未指定(フィルターなし)です。
                 page:
                   type: integer
                   minimum: 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pokepay_partner_ruby_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.2.0
 platform: ruby
 authors:
 - Pocket Change, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,10 +144,12 @@ files:
 - 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_money_summary.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_transaction_by_request_id.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
@@ -173,7 +175,6 @@ files:
 - lib/pokepay_partner_ruby_sdk/response/account_balance.rb
 - lib/pokepay_partner_ruby_sdk/response/account_deleted.rb
 - lib/pokepay_partner_ruby_sdk/response/account_detail.rb
-- lib/pokepay_partner_ruby_sdk/response/account_status.rb
 - lib/pokepay_partner_ruby_sdk/response/account_with_user.rb
 - lib/pokepay_partner_ruby_sdk/response/account_without_private_money_detail.rb
 - lib/pokepay_partner_ruby_sdk/response/admin_user_with_shops_and_private_moneys.rb
@@ -211,6 +212,7 @@ files:
 - lib/pokepay_partner_ruby_sdk/response/pong.rb
 - lib/pokepay_partner_ruby_sdk/response/private_money.rb
 - lib/pokepay_partner_ruby_sdk/response/private_money_organization_summary.rb
+- lib/pokepay_partner_ruby_sdk/response/private_money_summary.rb
 - lib/pokepay_partner_ruby_sdk/response/product.rb
 - lib/pokepay_partner_ruby_sdk/response/response.rb
 - lib/pokepay_partner_ruby_sdk/response/shop_account.rb

data/lib/pokepay_partner_ruby_sdk/response/account_status.rb

@@ -1,11 +0,0 @@
-# DO NOT EDIT: File is generated by code generator.
-
-
-module Pokepay::Response
-  class AccountStatus
-    def initialize(row)
-      
-    end
-    
-  end
-end