Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/types/error/RecurringOrderFailureError.raml

@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+(package): Error
+type: ErrorObject
+displayName: RecurringOrderFailureError
+discriminatorValue: RecurringOrderFailure
+description: |
+  Returned when a subsequent Order for a [Recurring Order](ctp:api:type:RecurringOrder) could not be processed.
+properties:
+  code:
+    type: string
+  message:
+    type: string
+    description: |
+      Plain text description of the error.
+  details:
+    type: any
+    description: |
+      Details about the error's cause and the entities involved.

api-specs/api/types/error/graphql/GraphQLRecurringOrderFailureError.raml

@@ -0,0 +1,14 @@
+#%RAML 1.0 DataType
+(package): Error
+type: GraphQLErrorObject
+displayName: GraphQLRecurringOrderFailureError
+discriminatorValue: RecurringOrderFailure
+description: |
+  Returned when a subsequent Order for a [Recurring Order](ctp:api:type:RecurringOrder) could not be processed.
+properties:
+  code:
+    type: string
+  details:
+    type: any
+    description: |
+      Details about the error's cause and the entities involved.

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

@@ -0,0 +1,29 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+(beta): false
+displayName: RecurringOrderFailedMessage
+discriminatorValue: RecurringOrderFailed
+description: |
+  Generated after a [RecurringOrder](ctp:api:type:RecurringOrder) failed to process an Order.
+properties:
+  cartId:
+    type: string
+    description: |
+      ID of the [Cart](ctp:api:type:Cart) used in the failed Order creation attempt.
+  failedAt:
+    type: datetime
+    description: |
+      Date and time (UTC) when the Order creation attempt failed.
+  failureReason:
+    type: string
+    description: |
+      Description of why the Order creation failed, such as insufficient stock.
+  orderScheduledAt:
+    type: datetime
+    description: |
+      Date and time (UTC) the Order was scheduled to be created.
+  errors?:
+    type: RecurringOrderFailureError[]
+    description: |
+      Errors due to which the Order creation failed.

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

@@ -0,0 +1,29 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+(beta): false
+displayName: RecurringOrderFailedMessagePayload
+discriminatorValue: RecurringOrderFailed
+description: |
+  Generated after a [RecurringOrder](ctp:api:type:RecurringOrder) failed to process an Order.
+properties:
+  cartId:
+    type: string
+    description: |
+      ID of the [Cart](ctp:api:type:Cart) used in the failed Order creation attempt.
+  failedAt:
+    type: datetime
+    description: |
+      Date and time (UTC) when the Order creation attempt failed.
+  failureReason:
+    type: string
+    description: |
+      Description of why the Order creation failed, such as insufficient stock.
+  orderScheduledAt:
+    type: datetime
+    description: |
+      Date and time (UTC) the Order was scheduled to be created.
+  errors?:
+    type: RecurringOrderFailureError[]
+    description: |
+      Errors due to which the Order creation failed.

api-specs/api/types/types.raml

@@ -600,6 +600,7 @@ ProductPresentWithDifferentVariantSelectionError: !include error/ProductPresentW
 ProjectNotConfiguredForLanguagesError: !include error/ProjectNotConfiguredForLanguagesError.raml
 QueryComplexityLimitExceededError: !include error/QueryComplexityLimitExceededError.raml
 QueryTimedOutError: !include error/QueryTimedOutError.raml
+RecurringOrderFailureError: !include error/RecurringOrderFailureError.raml
 ReferenceExistsError: !include error/ReferenceExistsError.raml
 ReferencedResourceNotFoundError: !include error/ReferencedResourceNotFoundError.raml
 RequiredFieldError: !include error/RequiredFieldError.raml
@@ -686,6 +687,7 @@ GraphQLProductPresentWithDifferentVariantSelectionError: !include error/graphql/
 GraphQLProjectNotConfiguredForLanguagesError: !include error/graphql/GraphQLProjectNotConfiguredForLanguagesError.raml
 GraphQLQueryComplexityLimitExceededError: !include error/graphql/GraphQLQueryComplexityLimitExceededError.raml
 GraphQLQueryTimedOutError: !include error/graphql/GraphQLQueryTimedOutError.raml
+GraphQLRecurringOrderFailureError: !include error/graphql/GraphQLRecurringOrderFailureError.raml
 GraphQLReferenceExistsError: !include error/graphql/GraphQLReferenceExistsError.raml
 GraphQLReferencedResourceNotFoundError: !include error/graphql/GraphQLReferencedResourceNotFoundError.raml
 GraphQLRequiredFieldError: !include error/graphql/GraphQLRequiredFieldError.raml
@@ -1166,6 +1168,7 @@ RecurringOrderCustomTypeRemovedMessage: !include message/RecurringOrderCustomTyp
 RecurringOrderCustomTypeSetMessage: !include message/RecurringOrderCustomTypeSetMessage.raml
 RecurringOrderDeletedMessage: !include message/RecurringOrderDeletedMessage.raml
 RecurringOrderExpiresAtSetMessage: !include message/RecurringOrderExpiresAtSetMessage.raml
+RecurringOrderFailedMessage: !include message/RecurringOrderFailedMessage.raml
 RecurringOrderKeySetMessage: !include message/RecurringOrderKeySetMessage.raml
 RecurringOrderScheduleSetMessage: !include message/RecurringOrderScheduleSetMessage.raml
 RecurringOrderStartsAtSetMessage: !include message/RecurringOrderStartsAtSetMessage.raml
@@ -1513,6 +1516,7 @@ RecurringOrderCustomTypeRemovedMessagePayload: !include message/payload/Recurrin
 RecurringOrderCustomTypeSetMessagePayload: !include message/payload/RecurringOrderCustomTypeSetMessagePayload.raml
 RecurringOrderDeletedMessagePayload: !include message/payload/RecurringOrderDeletedMessagePayload.raml
 RecurringOrderExpiresAtSetMessagePayload: !include message/payload/RecurringOrderExpiresAtSetMessagePayload.raml
+RecurringOrderFailedMessagePayload: !include message/payload/RecurringOrderFailedMessagePayload.raml
 RecurringOrderKeySetMessagePayload: !include message/payload/RecurringOrderKeySetMessagePayload.raml
 RecurringOrderScheduleSetMessagePayload: !include message/payload/RecurringOrderScheduleSetMessagePayload.raml
 RecurringOrderStartsAtSetMessagePayload: !include message/payload/RecurringOrderStartsAtSetMessagePayload.raml

api-specs/graphql/schema.sdl

@@ -4628,6 +4628,17 @@ input EnumValueInput {
   label: String!
 }
 
+type RecurringOrderFailureError {
+  "Error identifier"
+  code: String!
+
+  "Plain text description of the cause of the error."
+  message: String!
+
+  "Information about the cause of the error."
+  details: Json!
+}
+
 type EventBridgeDestination implements Destination {
   source: String!
   region: String!
@@ -11045,6 +11056,15 @@ type RecurringOrderCustomFieldChanged implements MessagePayload {
   type: String!
 }
 
+type RecurringOrderFailed implements MessagePayload {
+  cartId: String!
+  failedAt: DateTime!
+  failureReason: String!
+  orderScheduledAt: DateTime!
+  errors: [RecurringOrderFailureError!]
+  type: String!
+}
+
 type RecurringOrderCustomFieldRemoved implements MessagePayload {
   name: String!
   type: String!