Updated API from documentation release

commercetools · Jun 13, 2024 · 61d668b · 61d668b
1 parent a1588f9
commit 61d668b
Show file tree

Hide file tree

Showing 50 changed files with 478 additions and 207 deletions.
diff --git a/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json b/api-specs/checkout/examples/message/ErrorInitBadConfigMessage.json
@@ -1,10 +1,10 @@
 {
-  "type": "error:init:bad_config",
+  "severity": "error",
   "code": "project_deactivated",
   "message": "commercetools Checkout {projectKey} is deactivated.",
   "payload": {
     "project": {
       "key": "{projectKey}"
     }
   }
-}
+}
diff --git a/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json b/api-specs/checkout/examples/message/InfoOrderCreatedMessage.json
@@ -1,10 +1,10 @@
 {
-  "type": "info:order:status",
+  "severity": "info",
   "code": "order_created",
   "message": "Order {orderId} created.",
   "payload": {
     "order": {
       "id": "{orderId}"
     }
   }
-}
+}
diff --git a/api-specs/checkout/types/responses/AdyenBadConfig.raml b/api-specs/checkout/types/responses/AdyenBadConfig.raml
diff --git a/api-specs/checkout/types/responses/AdyenInitError.raml b/api-specs/checkout/types/responses/AdyenInitError.raml
diff --git a/api-specs/checkout/types/responses/AdyenTimeout.raml b/api-specs/checkout/types/responses/AdyenTimeout.raml
diff --git a/api-specs/checkout/types/responses/ApplicationDeactivated.raml b/api-specs/checkout/types/responses/ApplicationDeactivated.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:init:bad_config`
+    description: \`error`
   message:
     type: string
     description: Application `{applicationKey}` for commercetools Checkout `{projectKey}` is disabled.
-  payload?:
+  payload:
     type: object
-    description: An object containing `projectKey` and `applicationKey`.
+    description: Contains the `project` and `application` objects with the related `key` property.
diff --git a/api-specs/checkout/types/responses/ApplicationNotFound.raml b/api-specs/checkout/types/responses/ApplicationNotFound.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:init:bad_config`
+    description: \`error`
   message:
     type: string
     description: Application `{applicationKey}` for commercetools Checkout `{projectKey}` not found.
-  payload?:
+  payload:
     type: object
-    description: An object containing `projectKey` and `applicationKey`.
+    description: Contains the `project` and `application` objects with the related `key` property.
diff --git a/api-specs/checkout/types/responses/BadInputData.raml b/api-specs/checkout/types/responses/BadInputData.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:init:bad_config`
+    description: \`error`
   message:
     type: string
     description: Some fields are invalid.
-  payload?:
+  payload:
     type: object
-    description: An object containing an array of `field`, `message`, and `invalidValue`.
+    description: Contains the `invalidFields` array of objects with the related `field`, `message`, and `invalidValue` properties.
diff --git a/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml b/api-specs/checkout/types/responses/CartEmptiedDuringCheckout.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:cart:empty`
+    description: \`error`
   message:
     type: string
     description: Cart `{cartId}` was emptied during checkout.
-  payload?:
+  payload:
     type: object
-    description: An object containing `cartId`.
+    description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CartEmpty.raml b/api-specs/checkout/types/responses/CartEmpty.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:cart:empty`
+    description: \`error`
   message:
     type: string
     description: Cart `{cartId}` is empty.
-  payload?:
+  payload:
     type: object
-    description: An object containing `cartId`.
+    description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CartNotFound.raml b/api-specs/checkout/types/responses/CartNotFound.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:cart:not_found`
+    description: \`error`
   message:
     type: string
     description: Cart `{cartId}` for commercetools Checkout `{projectKey}` and application `{applicationKey}` not found.
-  payload?:
+  payload:
     type: object
-    description: An object containing `projectKey`, `applicationKey`, and `cartId`.
+    description: Contains the `project`, `application`, and  `cart` objects with the related `key` and `id` properties.
diff --git a/api-specs/checkout/types/responses/CartWithExistingPayment.raml b/api-specs/checkout/types/responses/CartWithExistingPayment.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:payment:failed`
+    description: \`error`
   message:
     type: string
     description: Cart with existing approved payment.
-  payload?:
+  payload:
     type: object
-    description: An object containing `cartId`.
+    description: Contains the `cart` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CheckoutCancelled.raml b/api-specs/checkout/types/responses/CheckoutCancelled.raml
@@ -1,6 +1,6 @@
 #%RAML 1.0 DataType
 (annotations.package): responses
-type: ResponseMessage
+type: Message
 displayName: CheckoutCancelled
 discriminatorValue: checkout_cancelled
 description: |
@@ -9,9 +9,9 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`info:app:status`
+    description: \`info`
   message:
     type: string
     description: Checkout cancelled.
diff --git a/api-specs/checkout/types/responses/CheckoutCompleted.raml b/api-specs/checkout/types/responses/CheckoutCompleted.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`info:app:status`
+    description: \`info`
   message:
     type: string
     description: Checkout for `{orderId}` completed.
-  payload?:
+  payload:
     type: object
-    description: An object containing `orderId`.
+    description: Contains the `order` object with the `id` property.
diff --git a/api-specs/checkout/types/responses/CheckoutLoaded.raml b/api-specs/checkout/types/responses/CheckoutLoaded.raml
@@ -1,17 +1,17 @@
 #%RAML 1.0 DataType
 (annotations.package): responses
-type: ResponseMessage
+type: Message
 displayName: CheckoutLoaded
 discriminatorValue: checkout_loaded
 description: |
-  Generated when Checkout has been loaded successfully and is waiting for the configuration parameters passed in the `checkoutConfig` [object](/sdk).
+  Generated when Checkout is loaded and waiting for the configuration properties to be passed with the `checkoutFlow` or `paymentFlow` [method](/sdk).
 properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`info:app:status`
+    description: \`info`
   message:
     type: string
     description: Checkout loaded.
diff --git a/api-specs/checkout/types/responses/CheckoutStarted.raml b/api-specs/checkout/types/responses/CheckoutStarted.raml
@@ -1,17 +1,17 @@
 #%RAML 1.0 DataType
 (annotations.package): responses
-type: ResponseMessage
+type: Message
 displayName: CheckoutStarted
 discriminatorValue: checkout_started
 description: |
-  Generated when the configuration parameters are passed successfully through the `checkoutConfig` [object](/sdk) and the checkout process starts.
+  Generated when the configuration properties are passed successfully with the `checkoutFlow` or `paymentFlow` [method](/sdk) and the checkout process starts.
 properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`info:app:status`
+    description: \`info`
   message:
     type: string
     description: Checkout started.
diff --git a/api-specs/checkout/types/responses/DeprecatedFields.raml b/api-specs/checkout/types/responses/DeprecatedFields.raml
@@ -9,12 +9,12 @@ properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`warn:init:bad_config`
+    description: \`warn`
   message:
     type: string
     description: Some fields are deprecated.
-  payload?:
+  payload:
     type: object
-    description: An object containing an array of `field` and `message`.
+    description: Contains the `deprecatedFields` array.
diff --git a/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml b/api-specs/checkout/types/responses/ExternalTermsAndConditionsPending.raml
@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(annotations.package): responses
+type: Message
+displayName: ExternalTermsAndConditionsPending
+discriminatorValue: external_terms_and_conditions_pending
+description: |
+  Generated in Payment Only [mode](/../checkout/overview#complete-checkout-and-payment-only-modes) when the customer hasn't accepted the terms and conditions yet.
+properties:
+  code:
+    type: string
+    description:
+  severity:
+    type: string
+    description: \`info`
+  message:
+    type: string
+    description: External terms and conditions pending.
diff --git a/api-specs/checkout/types/responses/InitError.raml b/api-specs/checkout/types/responses/InitError.raml
@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(annotations.package): responses
+type: Message
+displayName: InitError
+discriminatorValue: init_error
+description: |
+  Generated when an error occurs during Checkout's initialization.
+properties:
+  code:
+    type: string
+    description:
+  severity:
+    type: string
+    description: \`error`
+  message:
+    type: string
+    description: Error during initialization.
diff --git a/api-specs/checkout/types/responses/InitTimeout.raml b/api-specs/checkout/types/responses/InitTimeout.raml
@@ -1,17 +1,17 @@
 #%RAML 1.0 DataType
 (annotations.package): responses
-type: ResponseMessage
+type: Message
 displayName: InitTimeout
 discriminatorValue: init_timeout
 description: |
-  Generated when Checkout has not received the configuration parameters passed through the `checkoutConfig` [object](/sdk) on time.
+  Generated when Checkout does not receive the configuration properties with the `checkoutFlow` or `paymentFlow` [method](/sdk) on time.
 properties:
   code:
     type: string
     description:
-  type:
+  severity:
     type: string
-    description: \`error:init:timeout`
+    description: \`error`
   message:
     type: string
     description: Timeout error, no init message received.
diff --git a/api-specs/checkout/types/responses/InvalidMode.raml b/api-specs/checkout/types/responses/InvalidMode.raml
@@ -0,0 +1,17 @@
+#%RAML 1.0 DataType
+(annotations.package): responses
+type: Message
+displayName: InvalidMode
+discriminatorValue: invalid_mode
+description: |
+  Generated when the Application does not support the requested Checkout [mode](/../checkout/overview#complete-checkout-and-payment-only-modes).
+properties:
+  code:
+    type: string
+    description:
+  severity:
+    type: string
+    description: \`info`
+  message:
+    type: string
+    description: \`{mode}` mode requires an application with mode type `{modeTypeRequested}`. Current mode `{modeTypeReceived}`.