pokepay_partner_ruby_sdk 0.1.18 → 0.2.0

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
@@ -160,6 +158,10 @@ components:
           $ref: '#/components/schemas/PrivateMoney'
         user:
           $ref: '#/components/schemas/User'
+        external_id:
+          type: string
+          nullable: true
+          maxLength: 50
     ShopAccount:
       x-pokepay-schema-type: "response"
       properties:
@@ -743,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
@@ -776,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:
@@ -875,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:
@@ -887,6 +919,33 @@ components:
           minimum: 0
         pagination:
           $ref: '#/components/schemas/Pagination'
+    PaginatedTransactionV2:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Transaction'
+        per_page:
+          type: integer
+        count:
+          type: integer
+        next_page_cursor_id:
+          type: string
+          format: uuid
+          nullable: true
+          description: |-
+            次ページ取得するためのID。
+
+            実際にはrows末尾
+        prev_page_cursor_id:
+          type: string
+          format: uuid
+          nullable: true
+          description: |-
+            前ページ取得するためのID。
+
+            実際にはrows先頭
     PaginatedTransfers:
       x-pokepay-schema-type: "response"
       properties:
@@ -1034,6 +1093,9 @@ components:
         private_money:
           title: 'キャンペーンを適用するマネー'
           $ref: '#/components/schemas/PrivateMoney'
+        dest_private_money:
+          title: 'ポイントを付与するマネー'
+          $ref: '#/components/schemas/PrivateMoney'
         point_calculation_rule:
           type: string
           title: 'ポイント計算ルール (banklisp表記)'
@@ -1045,6 +1107,18 @@ components:
           type: string
           enum: [enabled, disabled]
           title: 'キャンペーンの現在の状態'
+    PaginatedCampaigns:
+      x-pokepay-schema-type: "response"
+      properties:
+        rows:
+          type: array
+          items:
+            $ref: '#/components/schemas/Campaign'
+        count:
+          type: integer
+          minimum: 0
+        pagination:
+          $ref: '#/components/schemas/Pagination'
     BadRequest:
       x-pokepay-schema-type: "response"
       oneOf:
@@ -1409,7 +1483,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Account'
+                $ref: '#/components/schemas/AccountDetail'
         '400':
           $ref: '#/components/responses/BadRequest'
         '403':
@@ -2048,7 +2122,6 @@ paths:
         - Check
       summary: 'チャージQRコードの発行'
       x-pokepay-operator-name: "CreateCheck"
-      x-pokepay-allow-server-side: true
       requestBody:
         required: true
         content:
@@ -2151,7 +2224,7 @@ paths:
     get:
       tags:
         - Transaction
-      summary: '取引履歴を取得する'
+      summary: '【廃止】取引履歴を取得する'
       description: 取引一覧を返します。
       x-pokepay-operator-name: "ListTransactions"
       x-pokepay-allow-server-side: true
@@ -2224,12 +2297,11 @@ paths:
                     フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
                 transaction_id:
                   type: string
-                  format: uuid
                   title: '取引ID'
                   description: |-
                     取引IDです。
 
-                    フィルターとして使われ、指定された取引のみ一覧に表示されます。
+                    フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
                 organization_code:
                   type: string
                   pattern: '^[a-zA-Z0-9-]*$'
@@ -2306,7 +2378,7 @@ paths:
     post:
       tags:
         - Transaction
-      summary: 'チャージする(廃止予定)'
+      summary: '【廃止】チャージする'
       description: |-
         チャージ取引を作成します。このAPIは廃止予定です。以降は `CreateTopupTransaction` を使用してください。
       x-pokepay-operator-name: "CreateTransaction"
@@ -2359,6 +2431,184 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+  /transactions-v2:
+    get:
+      tags:
+        - Transaction
+      summary: '取引履歴を取得する'
+      description: 取引一覧を返します。
+      x-pokepay-operator-name: "ListTransactionsV2"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+
+                    指定したマネーでの取引が一覧に表示されます。
+                organization_code:
+                  type: string
+                  pattern: '^[a-zA-Z0-9-]*$'
+                  maxLength: 32
+                  title: '組織コード'
+                  description: |-
+                    組織コードです。
+
+                    フィルターとして使われ、指定された組織の店舗での取引のみ一覧に表示されます。
+                  example: 'pocketchange'
+                shop_id:
+                  type: string
+                  format: uuid
+                  title: '店舗ID'
+                  description: |-
+                    店舗IDです。
+
+                    フィルターとして使われ、指定された店舗での取引のみ一覧に表示されます。
+                terminal_id:
+                  type: string
+                  format: uuid
+                  title: '端末ID'
+                  description: |-
+                    端末IDです。
+
+                    フィルターとして使われ、指定された端末での取引のみ一覧に表示されます。
+                customer_id:
+                  type: string
+                  format: uuid
+                  title: 'エンドユーザーID'
+                  description: |-
+                    エンドユーザーIDです。
+
+                    フィルターとして使われ、指定されたエンドユーザーの取引のみ一覧に表示されます。
+                customer_name:
+                  type: string
+                  maxLength: 256
+                  title: 'エンドユーザー名'
+                  description: |-
+                    エンドユーザー名です。
+
+                    フィルターとして使われ、入力された名前に部分一致するエンドユーザーでの取引のみ一覧に表示されます。
+                  example: 太郎
+                description:
+                  type: string
+                  maxLength: 200
+                  title: '取引説明文'
+                  description: |-
+                    取引を指定の取引説明文でフィルターします。
+
+                    取引説明文が完全一致する取引のみ抽出されます。取引説明文は最大200文字で記録されています。
+                  example: 店頭QRコードによる支払い
+                transaction_id:
+                  type: string
+                  title: '取引ID'
+                  description: |-
+                    取引IDです。
+
+                    フィルターとして使われ、指定された取引IDに部分一致(前方一致)する取引のみが一覧に表示されます。
+                is_modified:
+                  type: boolean
+                  title: 'キャンセルフラグ'
+                  description: |-
+                    キャンセルフラグです。
+
+                    これにtrueを指定するとキャンセルされた取引のみ一覧に表示されます。
+                    デフォルト値はfalseで、キャンセルの有無にかかわらず一覧に表示されます。
+                types:
+                  type: array
+                  title: '取引種別 (複数指定可)、チャージ=topup、支払い=payment'
+                  example: '["topup", "payment"]'
+                  description: |-
+                    取引の種類でフィルターします。
+
+                    以下の種類を指定できます。
+
+                    1. topup
+                       店舗からエンドユーザーへの送金取引(チャージ)
+
+                    2. payment
+                       エンドユーザーから店舗への送金取引(支払い)
+
+                    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, expire]
+                from:
+                  type: string
+                  format: date-time
+                  title: '開始日時'
+                  description: |-
+                    抽出期間の開始日時です。
+
+                    フィルターとして使われ、開始日時以降に発生した取引のみ一覧に表示されます。
+                to:
+                  type: string
+                  format: date-time
+                  title: '終了日時'
+                  description: |-
+                    抽出期間の終了日時です。
+
+                    フィルターとして使われ、終了日時以前に発生した取引のみ一覧に表示されます。
+                next_page_cursor_id:
+                  type: string
+                  format: uuid
+                  title: '次ページへ遷移する際に起点となるtransactionのID'
+                  description: |-
+                    次ページへ遷移する際に起点となるtransactionのID(前ページの末尾要素のID)です。
+                    本APIのレスポンスにもnext_page_cursor_idが含まれており、これがnull値の場合は最後のページであることを意味します。
+                    UUIDである場合は次のページが存在することを意味し、このnext_page_cursor_idをリクエストパラメータに含めることで次ページに遷移します。
+
+                    next_page_cursor_idのtransaction自体は次のページには含まれません。
+                prev_page_cursor_id:
+                  type: string
+                  format: uuid
+                  title: '前ページへ遷移する際に起点となるtransactionのID'
+                  description: |-
+                    前ページへ遷移する際に起点となるtransactionのID(次ページの先頭要素のID)です。
+
+                    本APIのレスポンスにもprev_page_cursor_idが含まれており、これがnull値の場合は先頭のページであることを意味します。
+                    UUIDである場合は前のページが存在することを意味し、このprev_page_cursor_idをリクエストパラメータに含めることで前ページに遷移します。
+
+                    prev_page_cursor_idのtransaction自体は前のページには含まれません。
+                per_page:
+                  type: integer
+                  minimum: 1
+                  maximum: 1000
+                  title: '1ページ分の取引数'
+                  description: |-
+                    1ページ分の取引数です。
+
+                    デフォルト値は50です。
+                  example: 50
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedTransactionV2'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
   /transactions/topup:
     post:
       tags:
@@ -3128,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:
@@ -3589,7 +3872,7 @@ paths:
     post:
       tags:
         - Shop
-      summary: '新規店舗を追加する(廃止予定)'
+      summary: '【廃止】新規店舗を追加する'
       description: |-
         新規店舗を追加します。このAPIは廃止予定です。以降は `CreateShopV2` を使用してください。
       x-pokepay-operator-name: "CreateShop"
@@ -3986,29 +4269,73 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '404':
           $ref: '#/components/responses/NotFound'
-  /customers/transactions:
+  /private-moneys/{private_money_id}/summary:
     get:
       tags:
-        - Customer
-      summary: '取引履歴を取得する'
-      description: '取引一覧を返します。'
-      x-pokepay-operator-name: "ListCustomerTransactions"
+        - Private Money
+      summary: 取引サマリを取得する
+      x-pokepay-operator-name: "GetPrivateMoneySummary"
       x-pokepay-allow-server-side: true
       requestBody:
         required: true
         content:
           application/json:
             schema:
-              required: ["private_money_id"]
               properties:
-                private_money_id:
-                  type: string
-                  format: uuid
-                  title: 'マネーID'
-                  description: |-
-                    マネーIDです。
-                    フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
-                sender_customer_id:
+                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:
+        - Customer
+      summary: '取引履歴を取得する'
+      description: '取引一覧を返します。'
+      x-pokepay-operator-name: "ListCustomerTransactions"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+                    フィルターとして使われ、指定したマネーでの取引のみ一覧に表示されます。
+                sender_customer_id:
                   type: string
                   format: uuid
                   title: '送金エンドユーザーID'
@@ -4448,6 +4775,7 @@ paths:
                   title: 'ポイント負担先店舗ID'
                   description: |-
                     ポイントを負担する店舗のIDです。デフォルトではマネー発行体の本店が設定されます。
+                    ポイント負担先店舗は後から更新することはできません。
                 description:
                   type: string
                   maxLength: 200
@@ -4702,7 +5030,7 @@ paths:
                       // 対象商品を2つ以上購入したら500ポイント付与(固定額付与)
                       {
                         "point_amount": 500,
-                        "point_amount_unit": absolute",
+                        "point_amount_unit": "absolute",
                         "product_code": "4912345678904",
                         "required_count": 2
                       },
@@ -4766,6 +5094,96 @@ paths:
                   describe: |-
                     キャンペーンを適用する店舗IDを指定します (複数指定)。
                     指定しなかった場合は全店舗が対象になります。
+                minimum_number_for_combination_purchase:
+                  type: integer
+                  minimum: 1
+                  title: '複数種類の商品を同時購入するときの商品種別数の下限'
+                  description: |-
+                    複数種別の商品を同時購入したとき、同時購入キャンペーンの対象となる商品種別数の下限です。デフォルトでは未指定で、指定する場合は1以上の整数を指定します。
+
+                    このパラメータを指定するときは product_based_point_rules で商品毎のルールが指定されている必要があります。
+                    例えば、A商品とB商品とC商品のうち、キャンペーンの発火のために2商品以上が同時購入される必要があるときは 2 を指定します。
+
+                    例1: 商品A, Bが同時購入されたときに固定ポイント額(200ポイント)付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Aの商品コード"
+                        },
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Bの商品コード"
+                        }
+                      ]
+                    }
+                    ```
+
+                    例2: 商品A, Bが3個ずつ以上同時購入されたときに固定ポイント額(200ポイント)付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Aの商品コード",
+                          "required_count": 3
+                        },
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Bの商品コード",
+                          "required_count": 3
+                        }
+                      ]
+                    }
+                    ```
+
+                    例2: 商品A, B, Cのうち2商品以上が同時購入されたときに総額の10%ポイントが付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Aの商品コード",
+                          "is_multiply_by_count": true,
+                        },
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Bの商品コード",
+                          "is_multiply_by_count": true,
+                        },
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Cの商品コード",
+                          "is_multiply_by_count": true,
+                        }
+                      ]
+                    }
+                    ```
+                dest_private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'ポイント付与先となるマネーID'
+                  description: |-
+                    キャンペーンを駆動するイベントのマネーとは「別のマネー」に対してポイントを付けたいときに、そのマネーIDを指定します。
+
+                    ポイント付与先のマネーはキャンペーンを駆動するイベントのマネーと同一発行体が発行しているものに限ります。その他のマネーIDが指定された場合は private_money_not_found (422) が返ります。
+                    エンドユーザー、店舗、ポイント負担先店舗はポイント付与先マネーのウォレットを持っている必要があります。持っていない場合はポイントは付きません。
+                    元のイベントのマネーと異なる複数のマネーに対して同時にポイントを付与することはできません。重複可能に設定されている複数のキャンペーンで別々のポイント付与先マネーを指定した場合は最も優先度の高いものが処理され、残りは無視されます。
+                    キャンペーンのポイント付与先マネーは後から更新することはできません。
+                    デフォルトではポイント付与先はキャンペーンを駆動するイベントのマネー(private_money_idで指定したマネー)になります。
+
+                    別マネーに対するポイント付与は別のtransactionとなります。 RefundTransaction で元のイベントをキャンセルしたときはポイント付与のtransactionもキャンセルされ、逆にポイント付与のtransactionをキャンセルしたときは連動して元のイベントがキャンセルされます。
       responses:
         '200':
           description: OK
@@ -4779,3 +5197,584 @@ paths:
           $ref: '#/components/responses/Forbidden'
         '422':
           $ref: '#/components/responses/UnprocessableEntity'
+    get:
+      tags:
+        - Campaign
+      summary: 'キャンペーン一覧を取得する'
+      description: |-
+        マネーIDを指定してキャンペーンを取得します。
+        発行体の組織マネージャ権限で、自組織が発行するマネーのキャンペーンについてのみ閲覧可能です。
+        閲覧権限がない場合は unpermitted_admin_user エラー(422)が返ります。
+      x-pokepay-operator-name: "ListCampaigns"
+      x-pokepay-allow-server-side: true
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              required: ["private_money_id"]
+              properties:
+                private_money_id:
+                  type: string
+                  format: uuid
+                  title: 'マネーID'
+                  description: |-
+                    マネーIDです。
+
+                    フィルターとして使われ、指定したマネーでのキャンペーンのみ一覧に表示されます。
+                is_ongoing:
+                  type: boolean
+                  title: '現在適用可能なキャンペーンかどうか'
+                  description: |-
+                    有効化されており、現在キャンペーン期間内にあるキャンペーンをフィルターするために使われます。
+                    真であれば適用可能なもののみを抽出し、偽であれば適用不可なもののみを抽出します。
+                    デフォルトでは未指定(フィルターなし)です。
+                page:
+                  type: integer
+                  minimum: 1
+                  title: 'ページ番号'
+                  description: 取得したいページ番号です。
+                  example: 1
+                per_page:
+                  type: integer
+                  minimum: 1
+                  title: '1ページ分の取得数'
+                  description: 1ページ分の取得数です。デフォルトでは 20 になっています。
+                  example: 50
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaginatedCampaigns'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'
+  /campaigns/{campaign_id}:
+    get:
+      tags:
+        - Campaign
+      summary: 'キャンペーンを取得する'
+      description: |-
+        IDを指定してキャンペーンを取得します。
+        発行体の組織マネージャ権限で、自組織が発行するマネーのキャンペーンについてのみ閲覧可能です。
+        閲覧権限がない場合は unpermitted_admin_user エラー(422)が返ります。
+      x-pokepay-operator-name: "GetCampaign"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: campaign_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'キャンペーンID'
+          description: |-
+            キャンペーンIDです。
+
+            指定したIDのキャンペーンを取得します。存在しないIDを指定した場合は404エラー(NotFound)が返ります。
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Campaign'
+        '400':
+          $ref: '#/components/responses/InvalidParameters'
+        '422':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+    patch:
+      tags:
+        - Campaign
+      summary: 'ポイント付与キャンペーンを更新する'
+      description: |
+        ポイント付与キャンペーンを更新します。
+      x-pokepay-operator-name: "UpdateCampaign"
+      x-pokepay-allow-server-side: true
+      parameters:
+        - in: path
+          name: campaign_id
+          required: true
+          schema:
+            type: string
+            format: uuid
+            title: 'キャンペーンID'
+          description: |-
+            キャンペーンIDです。
+
+            指定したIDのキャンペーンを更新します。存在しないIDを指定した場合は404エラー(NotFound)が返ります。
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              properties:
+                name:
+                  title: 'キャンペーン名'
+                  type: string
+                  maxLength: 256
+                  description: |-
+                    キャンペーン名です。
+
+                    ポイント付与によってできるチャージ取引の説明文に転記されます。取引説明文はエンドユーザーからも確認できます。
+                starts_at:
+                  type: string
+                  format: date-time
+                  title: 'キャンペーン開始日時'
+                  description: |-
+                    キャンペーン開始日時です。
+                    キャンペーン期間中のみポイントが付与されます。
+                    開始日時よりも終了日時が前のときはcampaign_invalid_periodエラー(422)になります。
+                ends_at:
+                  type: string
+                  format: date-time
+                  title: 'キャンペーン終了日時'
+                  description: |-
+                    キャンペーン終了日時です。
+                    キャンペーン期間中のみポイントが付与されます。
+                    開始日時よりも終了日時が前のときはcampaign_invalid_periodエラー(422)になります。
+                priority:
+                  type: integer
+                  title: 'キャンペーンの適用優先度'
+                  description: |-
+                    キャンペーンの適用優先度です。
+
+                    優先度が大きいものから順に適用判定されていきます。
+                    キャンペーン期間が重なっている同一の優先度のキャンペーンが存在するとcampaign_period_overlapsエラー(422)になります。
+                event:
+                  type: string
+                  enum: [topup, payment, external-transaction]
+                  title: 'イベント種別'
+                  description: |-
+                    キャンペーンのトリガーとなるイベントの種類を指定します。
+
+                    以下のいずれかを指定できます。
+
+                    1. topup
+                       店舗からエンドユーザーへの送金取引(チャージ)
+                    2. payment
+                       エンドユーザーから店舗への送金取引(支払い)
+                    3. external-transaction
+                       ポケペイ外の取引(現金決済など)
+                description:
+                  type: string
+                  maxLength: 200
+                  title: 'キャンペーンの説明文'
+                  description:  |-
+                    キャンペーンの内容を記載します。管理画面などでキャンペーンを管理するための説明文になります。
+                status:
+                  type: string
+                  enum: [enabled, disabled]
+                  title: 'キャンペーン作成時の状態'
+                  description: |-
+                    キャンペーン作成時の状態を指定します。デフォルトではenabledです。
+
+                    以下のいずれかを指定できます。
+
+                    1. enabled
+                       有効
+                    2. disabled
+                       無効
+                point_expires_at:
+                  type: string
+                  format: date-time
+                  nullable: true
+                  title: 'ポイント有効期限(絶対日時指定)'
+                  description: |-
+                    キャンペーンによって付与されるポイントの有効期限を絶対日時で指定します。
+                    省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
+                point_expires_in_days:
+                  type: integer
+                  minimum: 1
+                  nullable: true
+                  title: 'ポイント有効期限(相対日数指定)'
+                  description: |-
+                    キャンペーンによって付与されるポイントの有効期限を相対日数で指定します。
+                    省略した場合はマネーに設定された有効期限と同じものがポイントの有効期限となります。
+                is_exclusive:
+                  type: boolean
+                  title: 'キャンペーンの重複設定'
+                  description: |-
+                    キャンペーンの重ね掛けを行うかどうかのフラグです。
+
+                    これにtrueを指定すると他のキャンペーンと同時適用されません。デフォルト値はtrueです。
+                    falseを指定すると次の優先度の重ね掛け可能なキャンペーンの適用判定に進みます。
+                subject:
+                  type: string
+                  enum: [money, all]
+                  title: 'ポイント付与の対象金額の種別'
+                  description: |-
+                    ポイント付与額を計算する対象となる金額の種類を指定します。デフォルト値はallです。
+                    eventとしてexternal-transactionを指定した場合はポイントとマネーの区別がないためsubjectの指定に関わらず常にallとなります。
+
+                    以下のいずれかを指定できます。
+
+                    1. money
+                    moneyを指定すると決済額の中で「マネー」を使って支払った額を対象にします
+
+                    2. all
+                    all を指定すると決済額全体を対象にします (「ポイント」での取引額を含む)
+                    注意: event を topup にしたときはポイントの付与に対しても適用されます
+                amount_based_point_rules:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      point_amount:
+                        type: number
+                        format: decimal
+                        minimum: 0
+                        title: '付与ポイント量'
+                        description: |-
+                          キャンペーンにより付与するポイント量。(必須項目)
+
+                          point_amount_unitにより指定される単位が絶対額のときは小数点以下が切り捨てられ整数として扱われます。
+                          パーセント指定の時は小数を許容し、割合計算後に小数点以下が切り捨てられます。
+                          いずれの場合も実際に付与されるポイントは整数のみです。
+                      point_amount_unit:
+                        type: string
+                        enum: [percent, absolute]
+                        title: '付与ポイント量の単位'
+                        description: |-
+                          キャンペーンにより付与するポイント量の単位を指定します。(必須項目)
+
+                          以下のいずれかを指定できます。
+
+                          1. percent
+                          付与するポイント量が元取引の取引額に応じて割合で変化するときに指定します。
+
+                          2. absolute
+                          付与するポイント量が元取引の取引額に依存しない絶対額であるときに指定します。
+                      subject_more_than:
+                        type: integer
+                        minimum: 0
+                        title: '対象金額の下限値 (x <)'
+                        description: |-
+                          対象金額の下限値 (x <) を指定します (ただし、指定された金額は含まない)。
+                          subject_more_than_or_equal といずれかのみ指定できます。
+                      subject_more_than_or_equal:
+                        type: integer
+                        minimum: 0
+                        title: '対象金額の下限値 (x <=)'
+                        description: |-
+                          対象金額の下限値 (x <=) を指定します。
+                          subject_more_than といずれかのみ指定できます。
+                      subject_less_than:
+                        type: integer
+                        minimum: 0
+                        title: '対象金額の上限値 (< x)'
+                        description: |-
+                          対象金額の上限値 (< x) を指定します (ただし、指定された金額は含まない)。
+                          subject_less_than_or_equal といずれかのみ指定できます。
+                      subject_less_than_or_equal:
+                        type: integer
+                        minimum: 0
+                        title: '対象金額の上限値 (<= x)'
+                        description: |-
+                          対象金額の上限値 (<= x) を指定します。
+                          subject_less_than といずれかのみ指定できます。
+                    example: |-
+                      {
+                        "point_amount": 5,
+                        "point_amount_unit": "percent",
+                        "subject_more_than_or_equal": 1000,
+                        "subject_less_than": 5000
+                      }
+
+                  title: '取引金額ベースのポイント付与ルール'
+                  nullable: true
+                  description:  |-
+                    金額をベースとしてポイント付与を行うルールを指定します。
+                    amount_based_point_rules と product_based_point_rules はどちらか一方しか指定できません。
+                    各ルールは一つのみ適用され、条件に重複があった場合は先に記載されたものが優先されます。
+
+                    例:
+                    ```javascript
+                    [
+                      // 1000円以上、5000円未満の決済には 5％
+                      {
+                        "point_amount": 5,
+                        "point_amount_unit": "percent",
+                        "subject_more_than_or_equal": 1000,
+                        "subject_less_than": 5000
+                      },
+                      // 5000円以上の決済には 10%
+                      {
+                        "point_amount": 10,
+                        "point_amount_unit": "percent",
+                        "subject_more_than_or_equal": 5000
+                      },
+                    ]
+                    ```
+
+                product_based_point_rules:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      point_amount:
+                        type: number
+                        format: decimal
+                        minimum: 0
+                        title: '付与ポイント量'
+                        description: |-
+                          キャンペーンにより付与するポイント量。単位は point_amount_unit で指定します。(必須項目)
+
+                          point_amount_unitにより指定される単位が絶対額のときは小数点以下が切り捨てられ整数として扱われます。
+                          パーセント指定の時は小数を許容し、割合計算後に小数点以下が切り捨てられます。
+                          いずれの場合も実際に付与されるポイントは整数のみです。
+                      point_amount_unit:
+                        type: string
+                        enum: [percent, absolute]
+                        title: '付与ポイント量の単位'
+                        description: |-
+                          キャンペーンにより付与するポイント量の単位を指定します。(必須項目)
+
+                          以下のいずれかを指定できます。
+
+                          1. percent
+                          付与するポイント量が元取引の取引額に応じて割合で変化するときに指定します。
+
+                          2. absolute
+                          付与するポイント量が元取引の取引額に依存しない絶対額であるときに指定します。
+                      product_code:
+                        type: string
+                        maxLength: 64
+                        title: '対象の製品コード'
+                        description: |-
+                          対象の製品コード (JANコードやISBNコードなど) を指定します。(必須項目)
+
+                          SQLのLIKE文のようにワイルドカードを使った製品コードのパターンを指定することもできます (例: 978-% でISBNコード)
+                        items:
+                          type: string
+                      required_count:
+                        type: integer
+                        minimum: 1
+                        title: '必要購入個数'
+                        description: |-
+                          キャンペーン適用のための対象商品の必要購入個数を指定します (例:商品Aを2個以上購入するとn%ポイント)。
+                          デフォルト値は1です。
+                      is_multiply_by_count:
+                        type: boolean
+                        title: '複数個購入したときにポイント付与額に個数を掛けるかどうか'
+                        description: |-
+                          キャンペーン対象の商品を複数個購入したときに、個数に応じてポイント付与額を増やすかどうかのフラグです。
+                          デフォルト値は false です。
+                      starts_at:
+                        type: string
+                        format: date-time
+                        title: '商品個別のキャンペーン開始日時'
+                        description: |-
+                          このルールを適用する開始日時を指定します。
+                          デフォルトではキャンペーン全体の開始日時が指定されます。
+                          商品個別にキャンペーン期間指定をする場合は、キャンペーン全体の期間指定の範囲内に入っている必要があります。
+                      ends_at:
+                        type: string
+                        format: date-time
+                        title: '商品個別のキャンペーン終了日時'
+                        description: |-
+                          このルールを適用する終了日時を指定します。
+                          デフォルトではキャンペーン全体の終了日時が指定されます。
+                          商品個別にキャンペーン期間指定をする場合は、キャンペーン全体の期間指定の範囲内に入っている必要があります。
+                    example: |-
+                      {
+                        "point_amount": 5,
+                        "point_amount_unit": "percent",
+                        "product_code": "4912345678904",
+                        "is_multiply_by_count": true,
+                        "required_count": 2
+                      }
+
+                  title: '商品情報ベースのポイント付与ルール'
+                  nullable: true
+                  description:  |-
+                    商品情報をベースとしてポイント付与を行うルールを指定します。
+                    ルールは商品ごとに設定可能で、ルールの配列として指定します。
+                    amount_based_point_rules と product_based_point_rules はどちらか一方しか指定できません。
+                    event が payment か external-transaction の時のみ有効です。
+                    各ルールの順序は問わず、適用可能なものは全て適用されます。
+                    一つの決済の中で複数の商品がキャンペーン適用可能な場合はそれぞれの商品についてのルールが適用され、ポイント付与額はその合算になります。
+
+                    例:
+                    ```javascript
+                    [
+                      // 対象商品の購入額から5%ポイント付与。複数購入時は単価の5%が付与される。
+                      {
+                        "point_amount": 5,
+                        "point_amount_unit": "percent",
+                        "product_code": "4912345678904",
+                      },
+                      // 対象商品の購入額から5%ポイント付与。複数購入時は購入総額の5%が付与される。
+                      {
+                        "point_amount": 5,
+                        "point_amount_unit": "percent",
+                        "product_code": "4912345678904",
+                        "is_multiply_by_count": true,
+                      },
+                      // 対象商品を2つ以上購入したら500ポイント付与(固定額付与)
+                      {
+                        "point_amount": 500,
+                        "point_amount_unit": absolute",
+                        "product_code": "4912345678904",
+                        "required_count": 2
+                      },
+                      // 書籍は10%ポイント付与
+                      // ※ISBNの形式はレジがポケペイに送信する形式に準じます
+                      {
+                        "point_amount": 10,
+                        "point_amount_unit": "percent",
+                        "product_code": "978-%",
+                      },
+                      // 一部の出版社の書籍は10%ポイント付与
+                      {
+                        "point_amount": 10,
+                        "point_amount_unit": "percent",
+                        "product_code": "978-4-01-%", // 旺文社
+                      }
+                    ]
+                    ```
+
+                applicable_days_of_week:
+                  type: array
+                  items:
+                    type: integer
+                    minimun: 0
+                    maximum: 6
+                  nullable: true
+                  title: 'キャンペーンを適用する曜日 (複数指定)'
+                  describe: |-
+                    キャンペーンを適用する曜日を指定します (複数指定)。
+                    曜日は整数で表します。月曜を 0 とし、日曜を 6 とします。
+                    指定しなかった場合は全日を対象にします (曜日による適用条件なし)
+                applicable_time_ranges:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      from:
+                        type: string
+                        description: |-
+                          時間帯の開始時刻 (HH:mmの形式)
+                      to:
+                        type: string
+                        description: |-
+                          時間帯の終了時刻 (HH:mmの形式)
+                    example: |-
+                      {
+                        "from": "12:00",
+                        "to": "23:59"
+                      }
+
+                  nullable: true
+                  title: 'キャンペーンを適用する時間帯 (複数指定)'
+                  describe: |-
+                    キャンペーンを適用する時間帯を指定します (複数指定可)。
+                    時間帯はfromとtoからなるオブジェクトで指定します。
+                    fromとtoは両方必要です。
+                applicable_shop_ids:
+                  type: array
+                  items:
+                    type: string
+                    format: uuid
+                  nullable: true
+                  title: 'キャンペーン適用対象となる店舗IDのリスト'
+                  describe: |-
+                    キャンペーンを適用する店舗IDを指定します (複数指定)。
+                    指定しなかった場合は全店舗が対象になります。
+                minimum_number_for_combination_purchase:
+                  type: integer
+                  minimum: 1
+                  nullable: true
+                  title: '複数種類の商品を同時購入するときの商品種別数の下限'
+                  description: |-
+                    複数種別の商品を同時購入したとき、同時購入キャンペーンの対象となる商品種別数の下限です。
+
+                    このパラメータを指定するときは product_based_point_rules で商品毎のルールが指定されている必要があります。
+                    例えば、A商品とB商品とC商品のうち、キャンペーンの発火のために2商品以上が同時購入される必要があるときは 2 を指定します。
+
+                    例1: 商品A, Bが同時購入されたときに固定ポイント額(200ポイント)付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Aの商品コード"
+                        },
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Bの商品コード"
+                        }
+                      ]
+                    }
+                    ```
+
+                    例2: 商品A, Bが3個ずつ以上同時購入されたときに固定ポイント額(200ポイント)付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Aの商品コード",
+                          "required_count": 3
+                        },
+                        {
+                          "point_amount": 100,
+                          "point_amount_unit": "absolute",
+                          "product_code": "商品Bの商品コード",
+                          "required_count": 3
+                        }
+                      ]
+                    }
+                    ```
+
+                    例2: 商品A, B, Cのうち2商品以上が同時購入されたときに総額の10%ポイントが付与
+                    ```javascript
+                    {
+                      minimum_number_for_combination_purchase: 2,
+                      product_based_point_rules: [
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Aの商品コード",
+                          "is_multiply_by_count": true,
+                        },
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Bの商品コード",
+                          "is_multiply_by_count": true,
+                        },
+                        {
+                          "point_amount": 10,
+                          "point_amount_unit": "percent",
+                          "product_code": "商品Cの商品コード",
+                          "is_multiply_by_count": true,
+                        }
+                      ]
+                    }
+                    ```
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Campaign'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '403':
+          $ref: '#/components/responses/Forbidden'
+        '404':
+          $ref: '#/components/responses/NotFound'
+        '422':
+          $ref: '#/components/responses/UnprocessableEntity'