@redotech/redo-api-schema 2.2.144 → 2.2.149
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 +27 -21
- package/lib/openapi.yaml +38 -27
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -958,38 +958,44 @@ export interface components {
|
|
|
958
958
|
* @description Shopify pixel event for storefront tracking.
|
|
959
959
|
*/
|
|
960
960
|
"storefront-event.schema": {
|
|
961
|
-
/** @description
|
|
962
|
-
|
|
963
|
-
/** @description
|
|
964
|
-
|
|
961
|
+
/** @description Anonymous identifier for users without account. */
|
|
962
|
+
anonymousId?: string;
|
|
963
|
+
/** @description Cart information. */
|
|
964
|
+
cart?: Record<string, never> | null;
|
|
965
|
+
/** @description Information about specific cart line item. */
|
|
966
|
+
cartLine?: Record<string, never>;
|
|
967
|
+
/** @description Checkout information. */
|
|
968
|
+
checkout?: Record<string, never>;
|
|
969
|
+
/** @description Collection information. */
|
|
970
|
+
collection?: Record<string, never>;
|
|
965
971
|
/** @description Customer information if available. */
|
|
966
|
-
customer?:
|
|
967
|
-
/**
|
|
968
|
-
|
|
972
|
+
customer?: Record<string, never> | null;
|
|
973
|
+
/**
|
|
974
|
+
* Format: email
|
|
975
|
+
* @description Customer email if available.
|
|
976
|
+
*/
|
|
977
|
+
customerEmail?: string;
|
|
978
|
+
/** @description Customer phone if available. */
|
|
979
|
+
customerPhone?: string;
|
|
969
980
|
/** @description Unique identifier for the event. */
|
|
970
981
|
eventId: string;
|
|
971
982
|
/**
|
|
972
|
-
* @description Name of the Shopify pixel event
|
|
983
|
+
* @description Name of the Shopify pixel event.
|
|
973
984
|
* @enum {string}
|
|
974
985
|
*/
|
|
975
|
-
eventName: "
|
|
976
|
-
/** @description
|
|
977
|
-
|
|
978
|
-
[key: string]: unknown;
|
|
979
|
-
};
|
|
980
|
-
/** @description Product ID if event is related to a specific product. */
|
|
981
|
-
productId?: string;
|
|
982
|
-
/** @description Whether the Redo protection was selected in the UI. */
|
|
983
|
-
redoSelected?: boolean;
|
|
984
|
-
/** @description The Shopify shop domain. */
|
|
985
|
-
shopDomain: string;
|
|
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
|
+
/** @description Product variant information. */
|
|
988
|
+
productVariant?: Record<string, never>;
|
|
986
989
|
/**
|
|
987
990
|
* Format: date-time
|
|
988
991
|
* @description ISO 8601 timestamp when the event occurred.
|
|
989
992
|
*/
|
|
990
993
|
timestamp: string;
|
|
991
|
-
/** @description
|
|
992
|
-
|
|
994
|
+
/** @description Page URL without query parameters. */
|
|
995
|
+
urlWithoutParams?: string;
|
|
996
|
+
/** @description Complete page URL with query parameters. */
|
|
997
|
+
urlWithParams?: string;
|
|
998
|
+
[key: string]: unknown;
|
|
993
999
|
};
|
|
994
1000
|
/**
|
|
995
1001
|
* Webhook create
|
package/lib/openapi.yaml
CHANGED
|
@@ -1045,59 +1045,70 @@ components:
|
|
|
1045
1045
|
title: Storefront Customer
|
|
1046
1046
|
type: object
|
|
1047
1047
|
storefront-event.schema:
|
|
1048
|
-
additionalProperties:
|
|
1048
|
+
additionalProperties: true
|
|
1049
1049
|
description: Shopify pixel event for storefront tracking.
|
|
1050
1050
|
properties:
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
description: Cart information if relevant to the event.
|
|
1054
|
-
clientId:
|
|
1055
|
-
description: Identifier for the client that generated the event.
|
|
1051
|
+
anonymousId:
|
|
1052
|
+
description: Anonymous identifier for users without account.
|
|
1056
1053
|
type: string
|
|
1054
|
+
cart:
|
|
1055
|
+
description: Cart information.
|
|
1056
|
+
type:
|
|
1057
|
+
- object
|
|
1058
|
+
- 'null'
|
|
1059
|
+
cartLine:
|
|
1060
|
+
description: Information about specific cart line item.
|
|
1061
|
+
type: object
|
|
1062
|
+
checkout:
|
|
1063
|
+
description: Checkout information.
|
|
1064
|
+
type: object
|
|
1065
|
+
collection:
|
|
1066
|
+
description: Collection information.
|
|
1067
|
+
type: object
|
|
1057
1068
|
customer:
|
|
1058
|
-
$ref: '#/components/schemas/storefront-customer.schema'
|
|
1059
1069
|
description: Customer information if available.
|
|
1060
|
-
|
|
1061
|
-
|
|
1070
|
+
type:
|
|
1071
|
+
- object
|
|
1072
|
+
- 'null'
|
|
1073
|
+
customerEmail:
|
|
1074
|
+
description: Customer email if available.
|
|
1075
|
+
format: email
|
|
1076
|
+
type: string
|
|
1077
|
+
customerPhone:
|
|
1078
|
+
description: Customer phone if available.
|
|
1062
1079
|
type: string
|
|
1063
1080
|
eventId:
|
|
1064
1081
|
description: Unique identifier for the event.
|
|
1065
1082
|
type: string
|
|
1066
1083
|
eventName:
|
|
1067
|
-
description: Name of the Shopify pixel event
|
|
1084
|
+
description: Name of the Shopify pixel event.
|
|
1068
1085
|
enum:
|
|
1086
|
+
- product_added_to_cart
|
|
1087
|
+
- product_removed_from_cart
|
|
1069
1088
|
- product_viewed
|
|
1070
|
-
- product_added
|
|
1071
1089
|
- checkout_started
|
|
1072
1090
|
- checkout_completed
|
|
1091
|
+
- checkout_contact_info_submitted
|
|
1073
1092
|
- page_viewed
|
|
1093
|
+
- collection_viewed
|
|
1074
1094
|
type: string
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
description: Additional context information.
|
|
1095
|
+
productVariant:
|
|
1096
|
+
description: Product variant information.
|
|
1078
1097
|
type: object
|
|
1079
|
-
productId:
|
|
1080
|
-
description: Product ID if event is related to a specific product.
|
|
1081
|
-
type: string
|
|
1082
|
-
redoSelected:
|
|
1083
|
-
description: Whether the Redo protection was selected in the UI.
|
|
1084
|
-
type: boolean
|
|
1085
|
-
shopDomain:
|
|
1086
|
-
description: The Shopify shop domain.
|
|
1087
|
-
type: string
|
|
1088
1098
|
timestamp:
|
|
1089
1099
|
description: ISO 8601 timestamp when the event occurred.
|
|
1090
1100
|
format: date-time
|
|
1091
1101
|
type: string
|
|
1092
|
-
|
|
1093
|
-
description:
|
|
1102
|
+
urlWithParams:
|
|
1103
|
+
description: Complete page URL with query parameters.
|
|
1104
|
+
type: string
|
|
1105
|
+
urlWithoutParams:
|
|
1106
|
+
description: Page URL without query parameters.
|
|
1094
1107
|
type: string
|
|
1095
1108
|
required:
|
|
1096
1109
|
- eventName
|
|
1097
1110
|
- eventId
|
|
1098
1111
|
- timestamp
|
|
1099
|
-
- clientId
|
|
1100
|
-
- shopDomain
|
|
1101
1112
|
title: Storefront Event
|
|
1102
1113
|
type: object
|
|
1103
1114
|
webhook-create.schema:
|
package/package.json
CHANGED