Updated API from documentation release

Author: ct-sdks[bot]

api-specs/api/types/event/BaseEvent.raml

@@ -0,0 +1,29 @@
+#%RAML 1.0 DataType
+(package): Event
+displayName: BaseEvent
+description: |
+  Base representation of an Event containing common fields to all [Event Types](#eventtype).
+properties:
+  id:
+    (identifier): true
+    type: string
+    description: Unique identifier of the Event.
+  notificationType:
+    type: string
+    enum:
+      - Event
+  resourceType:
+    type: EventSubscriptionResourceTypeId
+    description: |
+      The type of resource targeted by the Event.
+  type:
+    type: EventType
+    description: |
+      The type of Event that has occurred.
+  data:
+    type: object
+    description: |
+      An object containing details related to the Event.
+  createdAt:
+    type: datetime
+    description: Date and time (UTC) the Event was generated.

api-specs/api/types/event/Event.raml

@@ -21,10 +21,6 @@ properties:
     type: EventType
     description: |
       The type of Event that has occurred.
-  data:
-    type: object
-    description: |
-      An object containing details related to the Event.
   createdAt:
     type: datetime
     description: Date and time (UTC) the Event was generated.

api-specs/api/types/subscription/DeliveryPayload.raml

@@ -1,12 +1,21 @@
 #%RAML 1.0 DataType
 (package): Subscription
-type: object
+type: SubscriptionNotification
 displayName: DeliveryPayload
-discriminator: notificationType
+(ignoreValidators): [PolymorphicSubtypesRule]
 description: |
   All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
 properties:
-  notificationType:
+  projectKey:
     type: string
     description: |
-      Identifies the payload.
+      `key` of the [Project](ctp:api:type:Project).
+      Useful for processing notifications if the Destination receives them from multiple Projects.
+  resource:
+    type: Reference
+    description: |
+      Reference to the resource that triggered the notification.
+  resourceUserProvidedIdentifiers?:
+    type: UserProvidedIdentifiers
+    description: |
+      User-defined unique identifiers of the resource.

api-specs/api/types/subscription/EventDeliveryPayload.raml

@@ -1,6 +1,6 @@
 #%RAML 1.0 DataType
 (package): Subscription
-type: DeliveryPayload
+type: SubscriptionNotification
 displayName: EventDeliveryPayload
 discriminatorValue: Event
 example: !include ../../examples/Subscription/event-payload.example.json

api-specs/api/types/subscription/MessageDeliveryPayload.raml

@@ -16,11 +16,6 @@ properties:
     format: int64
     description: |
       Last seen version of the resource.
-  projectKey:
-    type: string
-    description: |
-      `key` of the [Project](ctp:api:type:Project).
-      Useful for processing notifications if the Destination receives them from multiple Projects.
   createdAt:
     type: datetime
     description: |
@@ -40,14 +35,6 @@ properties:
     format: int64
     description: |
       Version of the resource on which the update was performed.
-  resource:
-    type: Reference
-    description: |
-      Reference to the resource that triggered the notification.
-  resourceUserProvidedIdentifiers?:
-    type: UserProvidedIdentifiers
-    description: |
-      User-defined unique identifiers of the resource.
   payloadNotIncluded?:
     type: PayloadNotIncluded
     description: |

api-specs/api/types/subscription/ResourceCreatedDeliveryPayload.raml

@@ -7,19 +7,6 @@ example: !include ../../examples/Subscription/resource-created-payload.example.j
 description: |
   This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is created.
 properties:
-  projectKey:
-    type: string
-    description: |
-      `key` of the [Project](ctp:api:type:Project).
-      Useful for processing notifications if the Destination receives them from multiple Projects.
-  resource:
-    type: Reference
-    description: |
-      Reference to the resource that triggered the notification.
-  resourceUserProvidedIdentifiers?:
-    type: UserProvidedIdentifiers
-    description: |
-      User-defined unique identifiers of the resource.
   version:
     type: number
     format: int64

api-specs/api/types/subscription/ResourceDeletedDeliveryPayload.raml

@@ -7,19 +7,6 @@ example: !include ../../examples/Subscription/resource-deleted-payload.example.j
 description: |
   This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is deleted.
 properties:
-  projectKey:
-    type: string
-    description: |
-      `key` of the [Project](ctp:api:type:Project).
-      Useful for processing notifications if the Destination receives them from multiple Projects.
-  resource:
-    type: Reference
-    description: |
-      Reference to the resource that triggered the notification.
-  resourceUserProvidedIdentifiers?:
-    type: UserProvidedIdentifiers
-    description: |
-      User-defined unique identifiers of the resource.
   version:
     type: number
     format: int64

api-specs/api/types/subscription/ResourceUpdatedDeliveryPayload.raml

@@ -7,19 +7,6 @@ example: !include ../../examples/Subscription/resource-updated-payload.example.j
 description: |
   This payload is sent for a [ChangeSubscription](ctp:api:type:ChangeSubscription) when a resource is updated. This includes updates by a background process, like a change in product availability.
 properties:
-  projectKey:
-    type: string
-    description: |
-      `key` of the [Project](ctp:api:type:Project).
-      Useful for processing notifications if the Destination receives them from multiple Projects.
-  resource:
-    type: Reference
-    description: |
-      Reference to the resource that triggered the notification.
-  resourceUserProvidedIdentifiers?:
-    type: UserProvidedIdentifiers
-    description: |
-      User-defined unique identifiers of the resource.
   version:
     type: number
     format: int64

api-specs/api/types/subscription/SubscriptionNotification.raml

@@ -0,0 +1,12 @@
+#%RAML 1.0 DataType
+(package): Subscription
+type: object
+displayName: SubscriptionNotification
+discriminator: notificationType
+description: |
+  All payloads for the [PlatformFormat](ctp:api:type:PlatformFormat) share these common fields.
+properties:
+  notificationType:
+    type: string
+    description: |
+      Identifies the payload.

api-specs/api/types/types.raml

@@ -676,6 +676,7 @@ GraphQLSemanticErrorError: !include error/graphql/GraphQLSemanticErrorError.raml
 GraphQLShippingMethodDoesNotMatchCartError: !include error/graphql/GraphQLShippingMethodDoesNotMatchCartError.raml
 GraphQLStoreCartDiscountsLimitReachedError: !include error/graphql/GraphQLStoreCartDiscountsLimitReachedError.raml
 GraphQLSyntaxErrorError: !include error/graphql/GraphQLSyntaxErrorError.raml
+BaseEvent: !include event/BaseEvent.raml
 Event: !include event/Event.raml
 ImportContainerCreatedEvent: !include event/ImportContainerCreatedEvent.raml
 ImportContainerCreatedEventData: !include event/ImportContainerCreatedEventData.raml
@@ -2291,6 +2292,7 @@ SqsDestination: !include subscription/SqsDestination.raml
 Subscription: !include subscription/Subscription.raml
 SubscriptionDraft: !include subscription/SubscriptionDraft.raml
 SubscriptionHealthStatus: !include subscription/SubscriptionHealthStatus.raml
+SubscriptionNotification: !include subscription/SubscriptionNotification.raml
 SubscriptionPagedQueryResponse: !include subscription/SubscriptionPagedQueryResponse.raml
 SubscriptionUpdate: !include subscription/SubscriptionUpdate.raml
 SubscriptionUpdateAction: !include subscription/SubscriptionUpdateAction.raml