Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/types/message/OrderPaymentAddedMessage.raml

@@ -6,7 +6,7 @@ discriminatorValue: OrderPaymentAdded
 description: |
   Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a [Payment](ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction).
 properties:
-  payment:
+  paymentRef:
     type: PaymentReference
     description: |
       [Payment](ctp:api:type:Payment) that was added to the [Order](ctp:api:type:Order).

api-specs/api/types/message/OrderPaymentRemovedMessage.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+displayName: OrderPaymentRemovedMessage
+discriminatorValue: OrderPaymentRemoved
+description: |
+  Generated after a successful [Remove Payment](ctp:api:type:OrderRemovePaymentAction) update action or when a [Payment](ctp:api:type:Payment) is removed via [Order Edits](ctp:api:type:StagedOrderRemovePaymentAction).
+properties:
+  paymentRef:
+    type: PaymentReference
+    description: |
+      [Payment](ctp:api:type:Payment) that was removed from the [Order](ctp:api:type:Order).
+  removedPaymentInfo:
+    type: boolean
+    description: |
+      Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is `true` if all Payments have been removed (none remain), and `false` if there are still Payments associated with the Order after the removal.

api-specs/api/types/message/payload/OrderPaymentAddedMessagePayload.raml

@@ -6,7 +6,7 @@ discriminatorValue: OrderPaymentAdded
 description: |
   Generated after a successful [Add Payment](ctp:api:type:OrderAddPaymentAction) update action or when a [Payment](ctp:api:type:Payment) is added via [Order Edits](ctp:api:type:StagedOrderAddPaymentAction).
 properties:
-  payment:
+  paymentRef:
     type: PaymentReference
     description: |
       [Payment](ctp:api:type:Payment) that was added to the [Order](ctp:api:type:Order).

api-specs/api/types/message/payload/OrderPaymentRemovedMessagePayload.raml

@@ -0,0 +1,16 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+displayName: OrderPaymentRemovedMessagePayload
+discriminatorValue: OrderPaymentRemoved
+description: |
+  Generated after a successful [Remove Payment](ctp:api:type:OrderRemovePaymentAction) update action or when a [Payment](ctp:api:type:Payment) is removed via [Order Edits](ctp:api:type:StagedOrderRemovePaymentAction).
+properties:
+  paymentRef:
+    type: PaymentReference
+    description: |
+      [Payment](ctp:api:type:Payment) that was removed from the [Order](ctp:api:type:Order).
+  removedPaymentInfo:
+    type: boolean
+    description: |
+      Indicates whether the removal of the Payment resulted in no Payments remaining on the Order. The value is `true` if all Payments have been removed (none remain), and `false` if there are still Payments associated with the Order after the removal.

api-specs/api/types/order-edit/updates/StagedOrderAddPaymentAction.raml

@@ -4,6 +4,8 @@ example: !include ../../../examples/OrderEdit/StagedOrderAddPaymentAction.json
 type: StagedOrderUpdateAction
 displayName: StagedOrderAddPaymentAction
 discriminatorValue: addPayment
+description: |
+  Produces the [Order Payment Added](ctp:api:type:OrderPaymentAddedMessage) Message.
 properties:
   payment:
     type: PaymentResourceIdentifier

api-specs/api/types/order-edit/updates/StagedOrderRemovePaymentAction.raml

@@ -4,6 +4,8 @@ example: !include ../../../examples/OrderEdit/StagedOrderRemovePaymentAction.jso
 type: StagedOrderUpdateAction
 displayName: StagedOrderRemovePaymentAction
 discriminatorValue: removePayment
+description: |
+  Produces the [Order Payment Removed](ctp:api:type:OrderPaymentRemovedMessage) Message.
 properties:
   payment:
     type: PaymentResourceIdentifier

api-specs/api/types/order/updates/OrderAddPaymentAction.raml

@@ -4,6 +4,8 @@ example: !include ../../../examples/Order/OrderAddPaymentAction.json
 type: OrderUpdateAction
 displayName: OrderAddPaymentAction
 discriminatorValue: addPayment
+description: |
+  Produces the [Order Payment Added](ctp:api:type:OrderPaymentAddedMessage) Message.
 properties:
   payment:
     type: PaymentResourceIdentifier

api-specs/api/types/order/updates/OrderRemovePaymentAction.raml

@@ -4,6 +4,8 @@ example: !include ../../../examples/Order/OrderRemovePaymentAction.json
 type: OrderUpdateAction
 displayName: OrderRemovePaymentAction
 discriminatorValue: removePayment
+description: |
+  Produces the [Order Payment Removed](ctp:api:type:OrderPaymentRemovedMessage) Message.
 properties:
   payment:
     type: PaymentResourceIdentifier

api-specs/api/types/types.raml

@@ -1060,6 +1060,7 @@ OrderLineItemDistributionChannelSetMessage: !include message/OrderLineItemDistri
 OrderLineItemRemovedMessage: !include message/OrderLineItemRemovedMessage.raml
 OrderMessage: !include message/OrderMessage.raml
 OrderPaymentAddedMessage: !include message/OrderPaymentAddedMessage.raml
+OrderPaymentRemovedMessage: !include message/OrderPaymentRemovedMessage.raml
 OrderPaymentStateChangedMessage: !include message/OrderPaymentStateChangedMessage.raml
 OrderPurchaseOrderNumberSetMessage: !include message/OrderPurchaseOrderNumberSetMessage.raml
 OrderReturnShipmentStateChangedMessage: !include message/OrderReturnShipmentStateChangedMessage.raml
@@ -1391,6 +1392,7 @@ OrderLineItemDistributionChannelSetMessagePayload: !include message/payload/Orde
 OrderLineItemRemovedMessagePayload: !include message/payload/OrderLineItemRemovedMessagePayload.raml
 OrderMessagePayload: !include message/payload/OrderMessagePayload.raml
 OrderPaymentAddedMessagePayload: !include message/payload/OrderPaymentAddedMessagePayload.raml
+OrderPaymentRemovedMessagePayload: !include message/payload/OrderPaymentRemovedMessagePayload.raml
 OrderPaymentStateChangedMessagePayload: !include message/payload/OrderPaymentStateChangedMessagePayload.raml
 OrderPurchaseOrderNumberSetMessagePayload: !include message/payload/OrderPurchaseOrderNumberSetMessagePayload.raml
 # yamllint disable-line rule:line-length