ACP-3507 Renamed paymentServiceProviderData to preOrderPaymentData

spryker · Sep 19, 2024 · 459c516 · 459c516
1 parent 243441e
commit 459c516
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 29 deletions.
diff --git a/resources/api/openapi.yml b/resources/api/openapi.yml
@@ -158,25 +158,6 @@ paths:
 
 components:
     schemas:
-        InitializePaymentResponse:
-            properties:
-                isSuccessful:
-                    type: boolean
-                redirectUrl:
-                    type: string
-                    description: 'URL for payment authorization'
-                message:
-                    type: string
-                    nullable: true
-                paymentProviderData:
-                    type: object
-                    additionalProperties:
-                        type: string
-                    description: 'Key-value object with attributes that can be forwarded to the PSP implementation. https://swagger.io/docs/specification/data-models/dictionaries/'
-                    example:
-                        clientId: '#061280'
-                        publishableKey: '#061114'
-
         InitializePaymentRequest:
             type: object
             required:
@@ -252,13 +233,32 @@ components:
                     description: 'Provides checkout summary page URL.'
                     type: string
                     example: 'https://example.com/summary'
+
+        InitializePaymentResponse:
+            properties:
+                isSuccessful:
+                    type: boolean
+                redirectUrl:
+                    type: string
+                    description: 'URL for payment authorization'
+                message:
+                    type: string
+                    nullable: true
+                paymentProviderData:
+                    type: object
+                    additionalProperties:
+                        type: string
+                    description: 'Key-value object with attributes that can be forwarded to the PSP implementation. https://swagger.io/docs/specification/data-models/dictionaries/'
+                    example:
+                        clientId: '#061280'
+                        publishableKey: '#061114'
 
         ConfirmPreOrderPaymentRequest:
             type: object
             required:
                 - orderData
                 - orderReference
-                - paymentServiceProviderData
+                - preOrderPaymentData
             properties:
                 orderData:
                     description: 'Order data.'
@@ -320,7 +320,7 @@ components:
                 orderReference:
                     type: string
                     example: 'DE-123456'
-                paymentServiceProviderData:
+                preOrderPaymentData:
                     description: 'Key-value object with attributes that can be forwarded to the PSP implementation. https://swagger.io/docs/specification/data-models/dictionaries/'
                     type: string
                     additionalProperties:
@@ -341,9 +341,9 @@ components:
         CancelPreOrderPaymentRequest:
             type: object
             required:
-                - paymentServiceProviderData
+                - preOrderPaymentData
             properties:
-                paymentServiceProviderData:
+                preOrderPaymentData:
                     description: 'Key-value object with attributes that can be forwarded to the PSP implementation. https://swagger.io/docs/specification/data-models/dictionaries/'
                     type: string
                     additionalProperties:

diff --git a/src/Spryker/Shared/AppPayment/Transfer/app_payment.transfer.xml b/src/Spryker/Shared/AppPayment/Transfer/app_payment.transfer.xml
@@ -64,7 +64,7 @@
         <property name="transactionId" type="string"/>
         <property name="tenantIdentifier" type="string"/>
         <property name="orderReference" type="string"/>
-        <property name="paymentServiceProviderData" type="array" associative="true" singular="paymentServiceProviderDatum"/>
+        <property name="preOrderPaymentData" type="array" associative="true" singular="preOrderPaymentDatum"/>
     </transfer>
 
     <transfer name="ConfirmPreOrderPaymentResponse" strict="true">
@@ -78,7 +78,7 @@
         <property name="payment" type="Payment"/>
         <property name="transactionId" type="string"/>
         <property name="tenantIdentifier" type="string"/>
-        <property name="paymentServiceProviderData" type="array" associative="true" singular="paymentServiceProviderDatum"/>
+        <property name="preOrderPaymentData" type="array" associative="true" singular="preOrderPaymentDatum"/>
     </transfer>
 
     <transfer name="CancelPreOrderPaymentResponse" strict="true">

diff --git a/src/Spryker/Shared/AppPaymentBackendApi/Transfer/app_payment_backend_api.transfer.xml b/src/Spryker/Shared/AppPaymentBackendApi/Transfer/app_payment_backend_api.transfer.xml
@@ -11,7 +11,7 @@
         <property name="transactionId" type="string"/>
         <property name="tenantIdentifier" type="string"/>
         <property name="orderReference" type="string"/>
-        <property name="paymentServiceProviderData" type="array" associative="true" singular="paymentServiceProviderDatum"/>
+        <property name="preOrderPaymentData" type="array" associative="true" singular="preOrderPaymentDatum"/>
     </transfer>
 
     <transfer name="ConfirmPreOrderPaymentResponse" strict="true">
@@ -24,7 +24,7 @@
         <property name="payment" type="Payment"/>
         <property name="transactionId" type="string"/>
         <property name="tenantIdentifier" type="string"/>
-        <property name="paymentServiceProviderData" type="array" associative="true" singular="paymentServiceProviderDatum"/>
+        <property name="preOrderPaymentData" type="array" associative="true" singular="preOrderPaymentDatum"/>
     </transfer>
 
     <transfer name="CancelPreOrderPaymentResponse" strict="true">

diff --git a/...yker/Zed/AppPayment/Dependency/Plugin/AppPaymentPlatformCancelPreOrderPluginInterface.php b/...yker/Zed/AppPayment/Dependency/Plugin/AppPaymentPlatformCancelPreOrderPluginInterface.php
@@ -17,7 +17,7 @@ interface AppPaymentPlatformCancelPreOrderPluginInterface extends AppPaymentPlat
   * - Receives a `CancelPreOrderPaymentRequestTransfer` with:
   *   - `appConfig`
   *   - `payment`
-  *   - `paymentServiceProviderData`
+  *   - `preOrderPaymentData`
   * - Returns a `CancelPreOrderPaymentResponseTransfer`.
   * - Requires `CancelPreOrderPaymentResponseTransfer::isSuccessful`to be set.
   * - Requires `CancelPreOrderPaymentResponseTransfer::message` to be set when the 3rd party provider could not process the request or any other issue occurs.

diff --git a/...ker/Zed/AppPayment/Dependency/Plugin/AppPaymentPlatformConfirmPreOrderPluginInterface.php b/...ker/Zed/AppPayment/Dependency/Plugin/AppPaymentPlatformConfirmPreOrderPluginInterface.php
@@ -18,7 +18,7 @@ interface AppPaymentPlatformConfirmPreOrderPluginInterface extends AppPaymentPla
      *   - `appConfig`
      *   - `payment`
      *   - `orderReference`
-     *   - `paymentServiceProviderData`
+     *   - `preOrderPaymentData`
      * - Returns a `ConfirmPreOrderPaymentResponseTransfer`.
      * - Requires `ConfirmPreOrderPaymentResponseTransfer::isSuccessful`to be set.
      * - Requires `ConfirmPreOrderPaymentResponseTransfer::message` to be set when the 3rd party provider could not process the request or any other issue occurs.