airbyte-source-shopify 2.5.15__tar.gz → 2.5.17__tar.gz

{airbyte_source_shopify-2.5.15 → airbyte_source_shopify-2.5.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-shopify
-Version: 2.5.15
+Version: 2.5.17
 Summary: Source CDK implementation for Shopify.
 Home-page: https://airbyte.com
 License: ELv2

{airbyte_source_shopify-2.5.15 → airbyte_source_shopify-2.5.17}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "2.5.15"
+version = "2.5.17"
 name = "airbyte-source-shopify"
 description = "Source CDK implementation for Shopify."
 authors = [

{airbyte_source_shopify-2.5.15 → airbyte_source_shopify-2.5.17}/source_shopify/schemas/customer_journey_summary.json

@@ -191,6 +191,82 @@
               "type": ["null", "string"]
             }
           }
+        },
+        "moments": {
+          "description": "The events preceding a customer's order, such as shop sessions.",
+          "type": ["null", "array"],
+          "items": {
+            "type": ["null", "object"],
+            "properties": {
+              "id": {
+                "description": "A globally-unique ID.",
+                "type": ["null", "integer"]
+              },
+              "landing_page": {
+                "description": "URL of the first page the customer landed on for the session.",
+                "type": ["null", "string"]
+              },
+              "landing_page_html": {
+                "description": "Landing page information with URL linked in HTML. For example, the first page the customer visited was",
+                "type": ["null", "string"]
+              },
+              "occurred_at": {
+                "description": "The date and time when the customer's session occurred.",
+                "type": ["null", "string"],
+                "format": "date-time"
+              },
+              "referral_code": {
+                "description": "Marketing referral code from the link that the customer clicked to visit the store.",
+                "type": ["null", "string"]
+              },
+              "referrer_url": {
+                "description": "Webpage where the customer clicked a link that sent them to the online store.",
+                "type": ["null", "string"]
+              },
+              "source": {
+                "description": "Source from which the customer visited the store, such as a platform (Facebook, Google), email, direct, a website domain, QR code, or unknown.",
+                "type": ["null", "string"]
+              },
+              "source_type": {
+                "description": "Type of marketing tactic.",
+                "type": ["null", "string"]
+              },
+              "source_description": {
+                "description": "Describes the source explicitly for first or last session.",
+                "type": ["null", "string"]
+              },
+              "utm_parameters": {
+                "description": "A set of UTM parameters gathered from the URL parameters of the referrer.",
+                "type": ["null", "object"],
+                "properties": {
+                  "campaign": {
+                    "description": "The name of a marketing campaign.",
+                    "type": ["null", "string"]
+                  },
+                  "content": {
+                    "description": "Identifies specific content in a marketing campaign. Used to differentiate between similar content or links in a marketing campaign to determine which is the most effective.",
+                    "type": ["null", "string"]
+                  },
+                  "medium": {
+                    "description": "The medium of a marketing campaign, such as a banner or email newsletter.",
+                    "type": ["null", "string"]
+                  },
+                  "source": {
+                    "description": "The source of traffic to the merchant's store, such as Google or an email newsletter.",
+                    "type": ["null", "string"]
+                  },
+                  "term": {
+                    "description": "Paid search terms used by a marketing campaign.",
+                    "type": ["null", "string"]
+                  }
+                }
+              },
+              "admin_graphql_api_id": {
+                "description": "Unique identifier for the customer in the Admin GraphQL API.",
+                "type": ["null", "string"]
+              }
+            }
+          }
         }
       }
     },

{airbyte_source_shopify-2.5.15 → airbyte_source_shopify-2.5.17}/source_shopify/shopify_graphql/bulk/query.py

@@ -1105,6 +1105,29 @@ class CustomerJourney(ShopifyBulkQuery):
                                     term
                                 }
                             }
+                            customerJourney {
+                                moments {
+                                    ... on CustomerVisit {
+                                        id
+                                        landingPage
+                                        landingPageHtml
+                                        occurredAt
+                                        referralCode
+                                        referralInfoHtml
+                                        referrerUrl
+                                        source
+                                        sourceDescription
+                                        sourceType
+                                        utmParameters {
+                                            campaign
+                                            content
+                                            medium
+                                            source
+                                            term
+                                        }
+                                    }
+                                }
+                            }
                         }
                     }
                 }
@@ -1127,6 +1150,16 @@ class CustomerJourney(ShopifyBulkQuery):
         "sourceDescription",
         Field(name="utmParameters", fields=["campaign", "content", "medium", "source", "term"]),
     ]
+
+    customer_visit_fragment: List[InlineFragment] = [
+        InlineFragment(type="CustomerVisit", fields=visit_fields),
+    ]
+
+    # # use this in the next version
+    # moments_fields: List[Field] = [
+    #     Field(name="edges", fields=[Field(name="node", fields=customer_visit_fragment)]),
+    # ]
+
     customer_journey_summary_fields: List[Field] = [
         "ready",
         Field(name="momentsCount", fields=["count", "precision"]),
@@ -1134,6 +1167,8 @@ class CustomerJourney(ShopifyBulkQuery):
         "daysToConversion",
         Field(name="firstVisit", fields=visit_fields),
         Field(name="lastVisit", fields=visit_fields),
+        # # use this in the next version
+        # Field(name="moments", fields=moments_fields),
     ]
 
     query_nodes: List[Field] = [
@@ -1142,6 +1177,12 @@ class CustomerJourney(ShopifyBulkQuery):
         "createdAt",
         "updatedAt",
         Field(name="customerJourneySummary", fields=customer_journey_summary_fields),
+        Field(
+            name="customerJourney",
+            fields=[
+                Field(name="moments", fields=customer_visit_fragment),
+            ],
+        ),
     ]
 
     record_composition = {
@@ -1152,6 +1193,9 @@ class CustomerJourney(ShopifyBulkQuery):
         self,
         visit_data: Mapping[str, Any],
     ) -> MutableMapping[str, Any]:
+        if not visit_data:
+            return {}
+
         # save the id before it's resolved
         visit_data["admin_graphql_api_id"] = visit_data.get("id")
         # resolve the order_id to str
@@ -1162,14 +1206,24 @@ class CustomerJourney(ShopifyBulkQuery):
         visit_data = self.tools.fields_names_to_snake_case(visit_data)
         return visit_data
 
+    def process_moments(self, entity: List[Mapping[str, Any]]) -> List[MutableMapping[str, Any]]:
+        moments = []
+        for item in entity:
+            moments.append(self.process_visit(item))
+        return moments
+
     def process_customer_journey(self, record: MutableMapping[str, Any]) -> MutableMapping[str, Any]:
         customer_journey_summary = record.get("customerJourneySummary", {})
         if customer_journey_summary:
             # process first, last visit data
-            first_visit = customer_journey_summary.get("firstVisit", {})
-            last_visit = customer_journey_summary.get("lastVisit", {})
-            customer_journey_summary["firstVisit"] = self.process_visit(first_visit) if first_visit else {}
-            customer_journey_summary["lastVisit"] = self.process_visit(last_visit) if last_visit else {}
+            customer_journey_summary["firstVisit"] = self.process_visit(customer_journey_summary.get("firstVisit"))
+            customer_journey_summary["lastVisit"] = self.process_visit(customer_journey_summary.get("lastVisit"))
+
+            # # this will be a part of summary in the next api version
+            if customer_journey := record.get("customerJourney", {}):
+                moments = customer_journey.get("moments", [])
+                customer_journey_summary["moments"] = self.process_moments(moments)
+
         # cast field names to snake_case
         customer_journey_summary = self.tools.fields_names_to_snake_case(customer_journey_summary)
         return customer_journey_summary