@redotech/redo-api-schema 2.2.146 → 2.2.151
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/openapi.d.ts +7 -25
- package/lib/openapi.yaml +5 -50
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -160,7 +160,7 @@ export interface paths {
|
|
|
160
160
|
* Receive storefront events
|
|
161
161
|
* @description Processes events from storefronts using Shopify pixel event schema
|
|
162
162
|
*/
|
|
163
|
-
post: operations["
|
|
163
|
+
post: operations["Storefront Event"];
|
|
164
164
|
};
|
|
165
165
|
"/stores/{storeId}/webhooks": {
|
|
166
166
|
/**
|
|
@@ -957,7 +957,7 @@ export interface components {
|
|
|
957
957
|
* Storefront Event
|
|
958
958
|
* @description Shopify pixel event for storefront tracking.
|
|
959
959
|
*/
|
|
960
|
-
"storefront-event.schema":
|
|
960
|
+
"storefront-event.schema": {
|
|
961
961
|
/** @description Anonymous identifier for users without account. */
|
|
962
962
|
anonymousId?: string;
|
|
963
963
|
/** @description Cart information. */
|
|
@@ -978,43 +978,25 @@ export interface components {
|
|
|
978
978
|
/** @description Customer phone if available. */
|
|
979
979
|
customerPhone?: string;
|
|
980
980
|
/** @description Unique identifier for the event. */
|
|
981
|
-
eventId
|
|
981
|
+
eventId: string;
|
|
982
982
|
/**
|
|
983
983
|
* @description Name of the Shopify pixel event.
|
|
984
984
|
* @enum {string}
|
|
985
985
|
*/
|
|
986
|
-
eventName
|
|
986
|
+
eventName: "product_added_to_cart" | "product_removed_from_cart" | "product_viewed" | "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted" | "page_viewed" | "collection_viewed";
|
|
987
987
|
/** @description Product variant information. */
|
|
988
988
|
productVariant?: Record<string, never>;
|
|
989
989
|
/**
|
|
990
990
|
* Format: date-time
|
|
991
991
|
* @description ISO 8601 timestamp when the event occurred.
|
|
992
992
|
*/
|
|
993
|
-
timestamp
|
|
993
|
+
timestamp: string;
|
|
994
994
|
/** @description Page URL without query parameters. */
|
|
995
995
|
urlWithoutParams?: string;
|
|
996
996
|
/** @description Complete page URL with query parameters. */
|
|
997
997
|
urlWithParams?: string;
|
|
998
998
|
[key: string]: unknown;
|
|
999
|
-
}
|
|
1000
|
-
/** @enum {unknown} */
|
|
1001
|
-
eventName?: "product_added_to_cart";
|
|
1002
|
-
} | {
|
|
1003
|
-
/** @enum {unknown} */
|
|
1004
|
-
eventName?: "product_removed_from_cart";
|
|
1005
|
-
} | {
|
|
1006
|
-
/** @enum {unknown} */
|
|
1007
|
-
eventName?: "product_viewed";
|
|
1008
|
-
} | ({
|
|
1009
|
-
/** @enum {unknown} */
|
|
1010
|
-
eventName?: "checkout_started" | "checkout_completed" | "checkout_contact_info_submitted";
|
|
1011
|
-
}) | {
|
|
1012
|
-
/** @enum {unknown} */
|
|
1013
|
-
eventName?: "page_viewed";
|
|
1014
|
-
} | {
|
|
1015
|
-
/** @enum {unknown} */
|
|
1016
|
-
eventName?: "collection_viewed";
|
|
1017
|
-
});
|
|
999
|
+
};
|
|
1018
1000
|
/**
|
|
1019
1001
|
* Webhook create
|
|
1020
1002
|
* @description Webhook create.
|
|
@@ -1682,7 +1664,7 @@ export interface operations {
|
|
|
1682
1664
|
* Receive storefront events
|
|
1683
1665
|
* @description Processes events from storefronts using Shopify pixel event schema
|
|
1684
1666
|
*/
|
|
1685
|
-
|
|
1667
|
+
"Storefront Event": {
|
|
1686
1668
|
parameters: {
|
|
1687
1669
|
path: {
|
|
1688
1670
|
storeId: components["parameters"]["store-id.param"];
|
package/lib/openapi.yaml
CHANGED
|
@@ -1046,56 +1046,7 @@ components:
|
|
|
1046
1046
|
type: object
|
|
1047
1047
|
storefront-event.schema:
|
|
1048
1048
|
additionalProperties: true
|
|
1049
|
-
allOf:
|
|
1050
|
-
- required:
|
|
1051
|
-
- eventName
|
|
1052
|
-
- eventId
|
|
1053
|
-
- timestamp
|
|
1054
|
-
- oneOf:
|
|
1055
|
-
- required:
|
|
1056
|
-
- customer
|
|
1057
|
-
- required:
|
|
1058
|
-
- anonymousId
|
|
1059
1049
|
description: Shopify pixel event for storefront tracking.
|
|
1060
|
-
oneOf:
|
|
1061
|
-
- properties:
|
|
1062
|
-
eventName:
|
|
1063
|
-
enum:
|
|
1064
|
-
- product_added_to_cart
|
|
1065
|
-
required:
|
|
1066
|
-
- cartLine
|
|
1067
|
-
- cart
|
|
1068
|
-
- properties:
|
|
1069
|
-
eventName:
|
|
1070
|
-
enum:
|
|
1071
|
-
- product_removed_from_cart
|
|
1072
|
-
required:
|
|
1073
|
-
- cartLine
|
|
1074
|
-
- cart
|
|
1075
|
-
- properties:
|
|
1076
|
-
eventName:
|
|
1077
|
-
enum:
|
|
1078
|
-
- product_viewed
|
|
1079
|
-
required:
|
|
1080
|
-
- productVariant
|
|
1081
|
-
- properties:
|
|
1082
|
-
eventName:
|
|
1083
|
-
enum:
|
|
1084
|
-
- checkout_started
|
|
1085
|
-
- checkout_completed
|
|
1086
|
-
- checkout_contact_info_submitted
|
|
1087
|
-
required:
|
|
1088
|
-
- checkout
|
|
1089
|
-
- properties:
|
|
1090
|
-
eventName:
|
|
1091
|
-
enum:
|
|
1092
|
-
- page_viewed
|
|
1093
|
-
- properties:
|
|
1094
|
-
eventName:
|
|
1095
|
-
enum:
|
|
1096
|
-
- collection_viewed
|
|
1097
|
-
required:
|
|
1098
|
-
- collection
|
|
1099
1050
|
properties:
|
|
1100
1051
|
anonymousId:
|
|
1101
1052
|
description: Anonymous identifier for users without account.
|
|
@@ -1154,6 +1105,10 @@ components:
|
|
|
1154
1105
|
urlWithoutParams:
|
|
1155
1106
|
description: Page URL without query parameters.
|
|
1156
1107
|
type: string
|
|
1108
|
+
required:
|
|
1109
|
+
- eventName
|
|
1110
|
+
- eventId
|
|
1111
|
+
- timestamp
|
|
1157
1112
|
title: Storefront Event
|
|
1158
1113
|
type: object
|
|
1159
1114
|
webhook-create.schema:
|
|
@@ -1902,7 +1857,7 @@ paths:
|
|
|
1902
1857
|
/stores/{storeId}/storefront/events:
|
|
1903
1858
|
post:
|
|
1904
1859
|
description: Processes events from storefronts using Shopify pixel event schema
|
|
1905
|
-
operationId:
|
|
1860
|
+
operationId: Storefront Event
|
|
1906
1861
|
parameters:
|
|
1907
1862
|
- $ref: '#/components/parameters/store-id.param'
|
|
1908
1863
|
requestBody:
|
package/package.json
CHANGED