🎉 Source Shopify: add tender_transactions stream (#10449)

Author: Baz

airbyte-config/init/src/main/resources/seed/source_definitions.yaml

@@ -669,7 +669,7 @@
 - name: Shopify
   sourceDefinitionId: 9da77001-af33-4bcd-be46-6252bf9342b9
   dockerRepository: airbyte/source-shopify
-  dockerImageTag: 0.1.31
+  dockerImageTag: 0.1.32
   documentationUrl: https://docs.airbyte.io/integrations/sources/shopify
   icon: shopify.svg
   sourceType: api

airbyte-config/init/src/main/resources/seed/source_specs.yaml

@@ -7041,7 +7041,7 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
-- dockerImage: "airbyte/source-shopify:0.1.31"
+- dockerImage: "airbyte/source-shopify:0.1.32"
   spec:
     documentationUrl: "https://docs.airbyte.io/integrations/sources/shopify"
     connectionSpecification:

airbyte-integrations/connectors/source-shopify/Dockerfile

@@ -28,5 +28,5 @@ COPY source_shopify ./source_shopify
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.1.31
+LABEL io.airbyte.version=0.1.32
 LABEL io.airbyte.name=airbyte/source-shopify

airbyte-integrations/connectors/source-shopify/integration_tests/abnormal_state.json

@@ -55,5 +55,8 @@
   },
   "fulfillments": {
     "updated_at": "2024-07-08T05:40:38-07:00"
+  },
+  "tender_transactions": {
+    "processed_at": "2024-07-08T05:40:38-07:00"
   }
 }

airbyte-integrations/connectors/source-shopify/integration_tests/configured_catalog.json

@@ -132,6 +132,18 @@
       "cursor_field": ["created_at"],
       "destination_sync_mode": "append"
     },
+    {
+      "stream": {
+        "name": "tender_transactions",
+        "json_schema": {},
+        "supported_sync_modes": ["incremental", "full_refresh"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["processed_at"]
+      },
+      "sync_mode": "incremental",
+      "cursor_field": ["processed_at"],
+      "destination_sync_mode": "append"
+    },
     {
       "stream": {
         "name": "pages",

airbyte-integrations/connectors/source-shopify/integration_tests/state.json

@@ -55,5 +55,8 @@
   },
   "fulfillments": {
     "updated_at": "2021-09-10T06:48:10-07:00"
+  },
+  "tender_transactions": {
+    "processed_at": "2021-12-13T20:43:39-08:00"
   }
 }

airbyte-integrations/connectors/source-shopify/source_shopify/schemas/tender_transactions.json

@@ -0,0 +1,78 @@
+{
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": [
+        "null",
+        "integer"
+      ]
+    },
+    "order_id": {
+      "type": [
+        "null",
+        "integer"
+      ]
+    },
+    "amount": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "currency": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "user_id": {
+      "type": [
+        "null",
+        "integer"
+      ]
+    },
+    "test": {
+      "type": [
+        "null",
+        "boolean"
+      ]
+    },
+    "processed_at": {
+      "type": [
+        "null",
+        "string"
+      ],
+      "format": "date-time"
+    },
+    "remote_reference": {
+      "type": [
+        "null",
+        "string"
+      ]
+    },
+    "payment_details": {
+      "type": ["null", "object"],
+      "properties": {
+        "credit_card_number": {
+          "type": [
+            "null",
+            "string"
+          ]
+        },
+        "credit_card_company": {
+          "type": [
+            "null",
+            "string"
+          ]
+        }
+      }
+      
+    },
+    "payment_method": {
+      "type": [
+        "null",
+        "string"
+      ]
+    }
+  }
+}

airbyte-integrations/connectors/source-shopify/source_shopify/source.py

@@ -322,6 +322,15 @@ def path(self, stream_slice: Mapping[str, Any] = None, **kwargs) -> str:
         return f"orders/{order_id}/{self.data_field}.json"
 
 
+class TenderTransactions(IncrementalShopifyStream):
+    data_field = "tender_transactions"
+    cursor_field = "processed_at"
+    filter_field = "processed_at_min"
+
+    def path(self, **kwargs) -> str:
+        return f"{self.data_field}.json"
+
+
 class Pages(IncrementalShopifyStream):
     data_field = "pages"
 
@@ -473,6 +482,7 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
             Collects(config),
             OrderRefunds(config),
             OrderRisks(config),
+            TenderTransactions(config),
             Transactions(config),
             Pages(config),
             PriceRules(config),

airbyte-integrations/connectors/source-shopify/source_shopify/utils.py

@@ -11,7 +11,7 @@
 
 SCOPES_MAPPING = {
     "read_customers": ["Customers"],
-    "read_orders": ["Orders", "AbandonedCheckouts", "Transactions", "Fulfillments", "OrderRefunds", "OrderRisks"],
+    "read_orders": ["Orders", "AbandonedCheckouts", "TenderTransactions", "Transactions", "Fulfillments", "OrderRefunds", "OrderRisks"],
     "read_draft_orders": ["DraftOrders"],
     "read_products": ["Products", "CustomCollections", "Collects"],
     "read_content": ["Pages"],

airbyte-integrations/connectors/source-shopify/unit_tests/unit_test.py

@@ -31,6 +31,16 @@ def test_privileges_validation(requests_mock, basic_config):
     requests_mock.get("https://test_shop.myshopify.com/admin/oauth/access_scopes.json", json={"access_scopes": [{"handle": "read_orders"}]})
     source = SourceShopify()
 
-    expected = ["orders", "abandoned_checkouts", "metafields", "order_refunds", "order_risks", "transactions", "fulfillments", "shop"]
+    expected = [
+        "orders",
+        "abandoned_checkouts",
+        "metafields",
+        "order_refunds",
+        "order_risks",
+        "tender_transactions",
+        "transactions",
+        "fulfillments",
+        "shop",
+    ]
 
     assert [stream.name for stream in source.streams(basic_config)] == expected

docs/integrations/sources/shopify.md

@@ -33,6 +33,7 @@ This Source is capable of syncing the following core Streams:
 * [Orders Risks](https://shopify.dev/api/admin/rest/reference/orders/order-risk)
 * [Products](https://help.shopify.com/en/api/reference/products)
 * [Transactions](https://help.shopify.com/en/api/reference/orders/transaction)
+* [Tender Transactions](https://shopify.dev/api/admin-rest/2022-01/resources/tendertransaction))
 * [Pages](https://help.shopify.com/en/api/reference/online-store/page)
 * [Price Rules](https://help.shopify.com/en/api/reference/discounts/pricerule)
 * [Locations](https://shopify.dev/api/admin-rest/2021-10/resources/location)
@@ -101,6 +102,7 @@ This connector support both: `OAuth 2.0` and `API PASSWORD` (for private applica
 
 | Version | Date | Pull Request | Subject |
 | :--- | :--- | :--- | :--- |
+| 0.1.32 | 2022-02-18 | [10449](https://github.com/airbytehq/airbyte/pull/10449) | Added `tender_transactions` stream |
 | 0.1.31 | 2022-02-08 | [10175](https://github.com/airbytehq/airbyte/pull/10175) | Fixed compatibility issues for legacy user config |
 | 0.1.30 | 2022-01-24 | [9648](https://github.com/airbytehq/airbyte/pull/9648) | Added permission validation before sync |
 | 0.1.29 | 2022-01-20 | [9049](https://github.com/airbytehq/airbyte/pull/9248) | Added `shop_url` to the record for all streams |