[ci skip] updating documentation

braze-inc · Jan 21, 2022 · 057e601 · 057e601
1 parent 8b519a9
commit 057e601
Show file tree

Hide file tree

Showing 30 changed files with 1,487 additions and 1,450 deletions.
diff --git a/STABILIZING.md b/STABILIZING.md
@@ -1,6 +1,6 @@
 # Stabilization Candidates
 
-_Generated on **Thu Jan 20 2022 23:42:53 GMT+0000 (UTC)**_
+_Generated on **Fri Jan 21 2022 00:03:20 GMT+0000 (UTC)**_
 
 
 ### Unknown Status, needs immediate attention

diff --git a/docs/reference/README.md b/docs/reference/README.md
diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.json b/docs/reference/adobe/experience/adcloud/campaign.schema.json
@@ -104,6 +104,21 @@
             "xdm:sampleGroupId": "8676378",
             "xdm:currency": "USD"
         },
+        {
+            "@id": "12",
+            "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
+            "dsp:campaignName": "News At Cisco",
+            "dsp:campaignStatus": "Active",
+            "dsp:timezone": "America/New_York",
+            "dsp:type": "Media",
+            "dsp:userId": 495991,
+            "dsp:accountId": "1",
+            "dsp:advertiserId": "3",
+            "dsp:campaignStartTime": "2019-01-09 00:00:00",
+            "dsp:campaignEndTime": "2019-01-11 00:00:00",
+            "repo:createDate": "2019-04-26T14:00:00+00:00",
+            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+        },
         {
             "xdm:id": "100001061",
             "xdm:campaignId": "10001234",
@@ -132,21 +147,6 @@
             "searchads.CampaignObjective": "visit_web",
             "repo:createDate": "2019-04-26T14:00:00+00:00",
             "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-        },
-        {
-            "@id": "12",
-            "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
-            "dsp:campaignName": "News At Cisco",
-            "dsp:campaignStatus": "Active",
-            "dsp:timezone": "America/New_York",
-            "dsp:type": "Media",
-            "dsp:userId": 495991,
-            "dsp:accountId": "1",
-            "dsp:advertiserId": "3",
-            "dsp:campaignStartTime": "2019-01-09 00:00:00",
-            "dsp:campaignEndTime": "2019-01-11 00:00:00",
-            "repo:createDate": "2019-04-26T14:00:00+00:00",
-            "repo:modifyDate": "2019-04-26T14:00:00+00:00"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/adcloud/campaign.schema.md b/docs/reference/adobe/experience/adcloud/campaign.schema.md
@@ -27,6 +27,24 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
+```json
+{
+  "@id": "12",
+  "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
+  "dsp:campaignName": "News At Cisco",
+  "dsp:campaignStatus": "Active",
+  "dsp:timezone": "America/New_York",
+  "dsp:type": "Media",
+  "dsp:userId": 495991,
+  "dsp:accountId": "1",
+  "dsp:advertiserId": "3",
+  "dsp:campaignStartTime": "2019-01-09 00:00:00",
+  "dsp:campaignEndTime": "2019-01-11 00:00:00",
+  "repo:createDate": "2019-04-26T14:00:00+00:00",
+  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
+}
+```
+
 ```json
 {
   "xdm:id": "100001061",
@@ -62,24 +80,6 @@ Adobe Advertising Cloud ad campaign hierarchy details such as, account, package,
 }
 ```
 
-```json
-{
-  "@id": "12",
-  "dsp:campaignKey": "QEr8RnlYHwnG4KbFSQor",
-  "dsp:campaignName": "News At Cisco",
-  "dsp:campaignStatus": "Active",
-  "dsp:timezone": "America/New_York",
-  "dsp:type": "Media",
-  "dsp:userId": 495991,
-  "dsp:accountId": "1",
-  "dsp:advertiserId": "3",
-  "dsp:campaignStartTime": "2019-01-09 00:00:00",
-  "dsp:campaignEndTime": "2019-01-11 00:00:00",
-  "repo:createDate": "2019-04-26T14:00:00+00:00",
-  "repo:modifyDate": "2019-04-26T14:00:00+00:00"
-}
-```
-
 
 # Ad Campaign Detail Properties
 

diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.json
@@ -70,12 +70,6 @@
     "meta:titleId": "notificationsubscription##title##11091",
     "meta:descriptionId": "notificationsubscription##description##35941",
     "examples": [
-        {
-            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-            "xdm:type": "Campaign/SubscriptionList",
-            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-            "xdm:emailAddress": "[email protected]"
-        },
         {
             "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
             "xdm:type": "Campaign/SubscriptionList",
@@ -86,6 +80,12 @@
                 "xdm:remarkID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3be",
                 "xdm:remarkText": "Sorry, leave me alone. These are my personal comments"
             }
+        },
+        {
+            "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+            "xdm:type": "Campaign/SubscriptionList",
+            "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+            "xdm:emailAddress": "[email protected]"
         }
     ]
 }
diff --git a/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md b/docs/reference/adobe/experience/campaign/notificationsubscription.schema.md
@@ -20,15 +20,6 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 
 ## Notification Subscription Examples
 
-```json
-{
-  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
-  "xdm:type": "Campaign/SubscriptionList",
-  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
-  "xdm:emailAddress": "[email protected]"
-}
-```
-
 ```json
 {
   "xdm:topicID": "50ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
@@ -43,6 +34,15 @@ Adobe Campaign notification subscriptions allow end-users opt into topics that c
 }
 ```
 
+```json
+{
+  "xdm:topicID": "40ac9bf9-721d-44ac-8cf3-fb04c089f3bf",
+  "xdm:type": "Campaign/SubscriptionList",
+  "xdm:subscriptionDate": "2017-09-26T15:52:25+00:00",
+  "xdm:emailAddress": "[email protected]"
+}
+```
+
 
 # Notification Subscription Properties
 

diff --git a/...eference/adobe/experience/decisioning/experienceevent-proposition-interaction.schema.json b/...eference/adobe/experience/decisioning/experienceevent-proposition-interaction.schema.json
@@ -47,24 +47,6 @@
     "meta:titleId": "proposition-interaction##title##38171",
     "meta:descriptionId": "proposition-interaction##description##45571",
     "examples": [
-        {
-            "https://ns.adobe.com/experience/decisioning/propositions": [
-                {
-                    "xdm:items": [
-                        {
-                            "xdm:id": "experience1"
-                        }
-                    ]
-                },
-                {
-                    "xdm:items": [
-                        {
-                            "xdm:id": "personalized-offer:f67bab756ed6ee4"
-                        }
-                    ]
-                }
-            ]
-        },
         {
             "@id": "a7864a96-1eac-4934-ab44-54ad037b4f2b",
             "xdm:timestamp": "2020-09-26T15:52:25+00:00",
@@ -109,6 +91,24 @@
                     "xdm:scope": "scope:12cfc3fa94281acb"
                 }
             ]
+        },
+        {
+            "https://ns.adobe.com/experience/decisioning/propositions": [
+                {
+                    "xdm:items": [
+                        {
+                            "xdm:id": "experience1"
+                        }
+                    ]
+                },
+                {
+                    "xdm:items": [
+                        {
+                            "xdm:id": "personalized-offer:f67bab756ed6ee4"
+                        }
+                    ]
+                }
+            ]
         }
     ]
 }
diff --git a/.../adobe/experience/decisioning/experienceevent-proposition-interaction.schema.md b/.../adobe/experience/decisioning/experienceevent-proposition-interaction.schema.md
@@ -19,27 +19,6 @@ Captures information regarding an action taken for one or more prior proposition
 
 ## Experience Event - Proposition Interactions Examples
 
-```json
-{
-  "https://ns.adobe.com/experience/decisioning/propositions": [
-    {
-      "xdm:items": [
-        {
-          "xdm:id": "experience1"
-        }
-      ]
-    },
-    {
-      "xdm:items": [
-        {
-          "xdm:id": "personalized-offer:f67bab756ed6ee4"
-        }
-      ]
-    }
-  ]
-}
-```
-
 ```json
 {
   "@id": "a7864a96-1eac-4934-ab44-54ad037b4f2b",
@@ -88,6 +67,27 @@ Captures information regarding an action taken for one or more prior proposition
 }
 ```
 
+```json
+{
+  "https://ns.adobe.com/experience/decisioning/propositions": [
+    {
+      "xdm:items": [
+        {
+          "xdm:id": "experience1"
+        }
+      ]
+    },
+    {
+      "xdm:items": [
+        {
+          "xdm:id": "personalized-offer:f67bab756ed6ee4"
+        }
+      ]
+    }
+  ]
+}
+```
+
 
 # Experience Event - Proposition Interactions Properties
 

diff --git a/...rience/journeyOrchestration/journeyOrchestrationServiceEventsSegmentExportJob.schema.json b/...rience/journeyOrchestration/journeyOrchestrationServiceEventsSegmentExportJob.schema.json
@@ -96,16 +96,16 @@
             "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/segmentExportJob": {
                 "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/ID": "12ae3-abe2c-12214-667ab",
                 "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/exportSegmentID": "12ae3-abe2c-12214-667ab-aa123",
-                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/status": "queued",
-                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "info"
+                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "error",
+                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventCode": "ERROR_INSTANCE_DUPLICATION"
             }
         },
         {
             "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/segmentExportJob": {
                 "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/ID": "12ae3-abe2c-12214-667ab",
                 "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/exportSegmentID": "12ae3-abe2c-12214-667ab-aa123",
-                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "error",
-                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventCode": "ERROR_INSTANCE_DUPLICATION"
+                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/status": "queued",
+                "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "info"
             }
         }
     ]

diff --git a/...ourneyOrchestration/journeyOrchestrationServiceEventsSegmentExportJob.schema.md b/...ourneyOrchestration/journeyOrchestrationServiceEventsSegmentExportJob.schema.md
@@ -32,8 +32,8 @@ This event is in relation with journey and Segment Export Job service event fiel
   "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/segmentExportJob": {
     "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/ID": "12ae3-abe2c-12214-667ab",
     "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/exportSegmentID": "12ae3-abe2c-12214-667ab-aa123",
-    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/status": "queued",
-    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "info"
+    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "error",
+    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventCode": "ERROR_INSTANCE_DUPLICATION"
   }
 }
 ```
@@ -43,8 +43,8 @@ This event is in relation with journey and Segment Export Job service event fiel
   "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/segmentExportJob": {
     "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/ID": "12ae3-abe2c-12214-667ab",
     "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/exportSegmentID": "12ae3-abe2c-12214-667ab-aa123",
-    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "error",
-    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventCode": "ERROR_INSTANCE_DUPLICATION"
+    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/status": "queued",
+    "https://ns.adobe.com/experience/journeyOrchestration/serviceEvents/eventType": "info"
   }
 }
 ```

diff --git a/.../experience/journeyOrchestration/stepEvents/journeyStepEventCommonFieldsMixin.schema.json b/.../experience/journeyOrchestration/stepEvents/journeyStepEventCommonFieldsMixin.schema.json
@@ -395,7 +395,17 @@
             "https://ns.adobe.com/experience/journeyOrchestration/stepStatus": "endStep",
             "https://ns.adobe.com/experience/journeyOrchestration/journeyID": "fc0b645e-b3e3-4441-99e1-faf3f9c7064f",
             "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionID": "f3485959-0a9e-4004-82d9-f11bd6c4585b",
-            "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionName": "Step_Event_test_2"
+            "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionName": "Step_Event_test_2",
+            "https://ns.adobe.com/experience/journeyOrchestration/journeyNodeProcessed": true,
+            "https://ns.adobe.com/experience/journeyOrchestration/nodeName": "SendPush",
+            "https://ns.adobe.com/experience/journeyOrchestration/eventProcessed": true,
+            "https://ns.adobe.com/experience/journeyOrchestration/nodeType": "event",
+            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeID": "c19714bc-e74f-4448-94a5-425b7b609321",
+            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeType": "action",
+            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeName": "email-welcome",
+            "https://ns.adobe.com/experience/journeyOrchestration/parentTransitionType": "event",
+            "https://ns.adobe.com/experience/journeyOrchestration/eventName": "beaconEvent",
+            "https://ns.adobe.com/experience/journeyOrchestration/isExternalEvent": true
         },
         {
             "https://ns.adobe.com/experience/journeyOrchestration/entrance": true,
@@ -408,18 +418,13 @@
             "https://ns.adobe.com/experience/journeyOrchestration/stepStatus": "endStep",
             "https://ns.adobe.com/experience/journeyOrchestration/journeyID": "fc0b645e-b3e3-4441-99e1-faf3f9c7064f",
             "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionID": "f3485959-0a9e-4004-82d9-f11bd6c4585b",
-            "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionName": "Step_Event_test_2",
-            "https://ns.adobe.com/experience/journeyOrchestration/journeyNodeProcessed": true,
-            "https://ns.adobe.com/experience/journeyOrchestration/nodeName": "SendPush",
-            "https://ns.adobe.com/experience/journeyOrchestration/eventProcessed": true,
-            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyID": "c19714bc-e74f-4448-94a5-425b7b609911",
-            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyVersionID": "c19714bc-e74f-4448-94a5-425b7b609932",
-            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyInstanceID": "c19dj3214bc-e74f-4448-94a5-425b7b609911",
-            "https://ns.adobe.com/experience/journeyOrchestration/previousJumpJourneyID": "c19714bc-4576-4448-94a5-425b7b609911",
-            "https://ns.adobe.com/experience/journeyOrchestration/reactionActionID": "c19714bc-4576-4448-94a5-425b7b609911",
-            "https://ns.adobe.com/experience/journeyOrchestration/reactionChannel": "email",
-            "https://ns.adobe.com/experience/journeyOrchestration/reactionInteractionType": "open",
-            "https://ns.adobe.com/experience/journeyOrchestration/batchRecurrenceIndex": 1
+            "https://ns.adobe.com/experience/journeyOrchestration/journeyVersionName": "Step_Event_test_2"
+        },
+        {
+            "https://ns.adobe.com/experience/journeyOrchestration/hasSegmentQualificationDelta": true,
+            "https://ns.adobe.com/experience/journeyOrchestration/startSegmentQualificationTime": "2021-01-26T06:23:28.914Z",
+            "https://ns.adobe.com/experience/journeyOrchestration/endSegmentQualificationTime": "2021-01-26T06:24:28.914Z",
+            "https://ns.adobe.com/experience/journeyOrchestration/segmentQualificationStatus": "inSegment"
         },
         {
             "https://ns.adobe.com/experience/journeyOrchestration/entrance": true,
@@ -436,19 +441,14 @@
             "https://ns.adobe.com/experience/journeyOrchestration/journeyNodeProcessed": true,
             "https://ns.adobe.com/experience/journeyOrchestration/nodeName": "SendPush",
             "https://ns.adobe.com/experience/journeyOrchestration/eventProcessed": true,
-            "https://ns.adobe.com/experience/journeyOrchestration/nodeType": "event",
-            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeID": "c19714bc-e74f-4448-94a5-425b7b609321",
-            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeType": "action",
-            "https://ns.adobe.com/experience/journeyOrchestration/parentNodeName": "email-welcome",
-            "https://ns.adobe.com/experience/journeyOrchestration/parentTransitionType": "event",
-            "https://ns.adobe.com/experience/journeyOrchestration/eventName": "beaconEvent",
-            "https://ns.adobe.com/experience/journeyOrchestration/isExternalEvent": true
-        },
-        {
-            "https://ns.adobe.com/experience/journeyOrchestration/hasSegmentQualificationDelta": true,
-            "https://ns.adobe.com/experience/journeyOrchestration/startSegmentQualificationTime": "2021-01-26T06:23:28.914Z",
-            "https://ns.adobe.com/experience/journeyOrchestration/endSegmentQualificationTime": "2021-01-26T06:24:28.914Z",
-            "https://ns.adobe.com/experience/journeyOrchestration/segmentQualificationStatus": "inSegment"
+            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyID": "c19714bc-e74f-4448-94a5-425b7b609911",
+            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyVersionID": "c19714bc-e74f-4448-94a5-425b7b609932",
+            "https://ns.adobe.com/experience/journeyOrchestration/originJumpJourneyInstanceID": "c19dj3214bc-e74f-4448-94a5-425b7b609911",
+            "https://ns.adobe.com/experience/journeyOrchestration/previousJumpJourneyID": "c19714bc-4576-4448-94a5-425b7b609911",
+            "https://ns.adobe.com/experience/journeyOrchestration/reactionActionID": "c19714bc-4576-4448-94a5-425b7b609911",
+            "https://ns.adobe.com/experience/journeyOrchestration/reactionChannel": "email",
+            "https://ns.adobe.com/experience/journeyOrchestration/reactionInteractionType": "open",
+            "https://ns.adobe.com/experience/journeyOrchestration/batchRecurrenceIndex": 1
         }
     ]
 }