Adding initial hyper t schemas.

snowplow · May 15, 2024 · 42ddd8c · 42ddd8c
1 parent dd45d7e
commit 42ddd8c
Show file tree

Hide file tree

Showing 42 changed files with 2,554 additions and 0 deletions.
diff --git a/schemas/io.snowplow.ecomm/add_discount/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_discount/jsonschema/1-0-0
@@ -0,0 +1,34 @@
+{
+    "description": "This event fires when a customer adds a discount to their order.",
+    "properties": {
+        "success": {
+            "type": [
+                "boolean",
+                "null"
+            ]
+        },
+        "error_code": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "maxLength": 255
+        },
+        "discount_id": {
+            "type": "string",
+            "maxLength": 255
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "add_discount",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "discount_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/add_payment_method/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_payment_method/jsonschema/1-0-0
@@ -0,0 +1,28 @@
+{
+    "description": "Event occurs when a payment method is added during checkout.",
+    "properties": {
+        "payment_id": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "new_payment": {
+            "type": [
+                "boolean",
+                "null"
+            ],
+            "description": "If this payment ID is new or from a saved payment on the customer's account."
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "add_payment_method",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "payment_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/add_shipping/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_shipping/jsonschema/1-0-0
@@ -0,0 +1,26 @@
+{
+    "description": "Event occurrs when shipping information is added during checkout.",
+    "properties": {
+        "cart_id": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "location_id": {
+            "type": "string",
+            "maxLength": 255
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "add_shipping",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "cart_id",
+        "location_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/add_to_cart/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_to_cart/jsonschema/1-0-0
@@ -0,0 +1,48 @@
+{
+    "description": "Event occurs when a product or bundle is added to a cart.",
+    "properties": {
+        "item_id": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "item_type": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Examples: \"product\", \"bundle\", \"gift_card\"",
+            "maxLength": 255
+        },
+        "quantity": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 2147483647
+        },
+        "cart_id": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "source": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Examples: \"catalog\", \"wishlist\"",
+            "maxLength": 255
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "add_to_cart",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "item_id",
+        "quantity",
+        "cart_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/add_to_list/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/add_to_list/jsonschema/1-0-0
@@ -0,0 +1,44 @@
+{
+    "description": "Event occurs when a product or bundle is added to a list by a customer; such as a comparison list, wish list, bookmarks/favorites list, or gift registry.",
+    "properties": {
+        "list_name": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "Name of the list the product was added to.",
+            "maxLength": 255
+        },
+        "list_id": {
+            "type": "string",
+            "description": "A unique identifier for the list the product was added to, if not a generic common list.",
+            "maxLength": 255
+        },
+        "entity_id": {
+            "type": "string",
+            "description": "ID reference to the entity (as listed in entity) that was added to the list.",
+            "maxLength": 255
+        },
+        "entity_type": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "The type of entity referenced by entity_id.",
+            "maxLength": 255
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "add_to_list",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "list_id",
+        "entity_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/begin_checkout/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/begin_checkout/jsonschema/1-0-0
@@ -0,0 +1,21 @@
+{
+    "description": "Event occurs when a customer enters the checkout sequence",
+    "properties": {
+        "cart_id": {
+            "type": "string",
+            "maxLength": 255
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "begin_checkout",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "cart_id"
+    ]
+}
diff --git a/schemas/io.snowplow.ecomm/cancel_subscription/jsonschema/1-0-0 b/schemas/io.snowplow.ecomm/cancel_subscription/jsonschema/1-0-0
@@ -0,0 +1,29 @@
+{
+    "description": "Event occurs when a customer cancels for a subscription",
+    "properties": {
+        "subscription_id": {
+            "type": "string",
+            "maxLength": 255
+        },
+        "reason": {
+            "type": [
+                "string",
+                "null"
+            ],
+            "description": "The reason if given in notes for why the subscription was cancelled.",
+            "maxLength": 512
+        }
+    },
+    "additionalProperties": false,
+    "type": "object",
+    "self": {
+        "vendor": "io.snowplow.ecomm",
+        "name": "cancel_subscription",
+        "format": "jsonschema",
+        "version": "1-0-0"
+    },
+    "$schema": "http://iglucentral.com/schemas/com.snowplowanalytics.self-desc/schema/jsonschema/1-0-0#",
+    "required": [
+        "subscription_id"
+    ]
+}