✨Source Square: Add new stream Inventory (#31107)

Co-authored-by: Mal Hancock <[email protected]>

airbyte-integrations/connectors/source-square/Dockerfile

@@ -34,5 +34,5 @@ COPY source_square ./source_square
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=1.2.0
+LABEL io.airbyte.version=1.3.0
 LABEL io.airbyte.name=airbyte/source-square

airbyte-integrations/connectors/source-square/acceptance-test-config.yml

@@ -24,20 +24,12 @@ acceptance_tests:
           disable_for_version: "1.0.0"
   basic_read:
     tests:
-      - config_path: "secrets/config_oauth.json"
+      - config_path: "secrets/config.json"
         empty_streams:
-          - name: shifts
-            bypass_reason: "Not able to fill stream"
-          - name: orders
-            bypass_reason: "Not able to fill stream"
-          - name: payments
-            bypass_reason: "Not able to fill stream"
-          - name: refunds
-            bypass_reason: "Not able to fill stream"
           - name: cash_drawers
             bypass_reason: "Not able to fill stream"
         expect_records:
-          path: "integration_tests/expected_records_oauth.jsonl"
+          path: "integration_tests/expected_records.jsonl"
         ignored_fields:
           items:
             - name: version

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

@@ -24,6 +24,18 @@
       "cursor_field": ["updated_at"],
       "destination_sync_mode": "append"
     },
+    {
+      "stream": {
+        "name": "inventory",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_cursor": true,
+        "default_cursor_field": ["catalog_object_id"]
+      },
+      "sync_mode": "full_refresh",
+      "cursor_field": ["catalog_object_id"],
+      "destination_sync_mode": "overwrite"
+    },
     {
       "stream": {
         "name": "discounts",

airbyte-integrations/connectors/source-square/metadata.yaml

@@ -9,7 +9,7 @@ data:
   connectorSubtype: api
   connectorType: source
   definitionId: 77225a51-cd15-4a13-af02-65816bd0ecf4
-  dockerImageTag: 1.2.0
+  dockerImageTag: 1.3.0
   dockerRepository: airbyte/source-square
   documentationUrl: https://docs.airbyte.com/integrations/sources/square
   githubIssueLabel: source-square

airbyte-integrations/connectors/source-square/source_square/manifest.yaml

@@ -184,6 +184,24 @@ definitions:
       primary_key: "id"
       path: "/team-members/search"
 
+  inventory_stream:
+    $ref: "#/definitions/base_stream"
+    $parameters:
+      name: "inventory"
+      primary_key: "catalog_object_id"
+      path: "/inventory/counts/batch-retrieve"
+    retriever:
+      $ref: "#/definitions/base_stream_page_json_limit/retriever"
+      requester:
+        $ref: "#/definitions/base_stream_page_json_limit/retriever/requester"
+        http_method: "POST"
+        request_body_json:
+          limit: "{{ 500 }}"
+      record_selector:
+        $ref: "#/definitions/selector"
+        extractor:
+          field_path: ["counts"]
+
   team_member_wages_stream:
     $ref: "#/definitions/base_stream"
     $parameters:
@@ -327,6 +345,7 @@ streams:
   - "#/definitions/taxes_stream"
   - "#/definitions/modifier_list_stream"
   - "#/definitions/refunds_stream"
+  - "#/definitions/inventory_stream"
   - "#/definitions/payments_stream"
   - "#/definitions/orders_stream"
   - "#/definitions/cash_drawers_stream"

airbyte-integrations/connectors/source-square/source_square/schemas/inventory.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Inventory Schema",
+  "additionalProperties": true,
+  "type": ["object", "null"],
+  "properties": {
+    "catalog_object_id": {
+      "type": ["string", "null"]
+    },
+    "catalog_object_type": {
+      "type": ["string", "null"]
+    },
+    "state": {
+      "type": ["string", "null"]
+    },
+    "location_id": {
+      "type": ["string", "null"]
+    },
+    "quantity": {
+      "type": ["string", "null"]
+    },
+    "calculated_at": {
+      "type": ["string", "null"]
+    }
+  }
+}

docs/integrations/sources/square.md

@@ -68,6 +68,7 @@ The Square source connector supports the following [ sync modes](https://docs.ai
 - [List Team Member Wages](https://developer.squareup.com/explorer/square/labor-api/list-team-member-wages)
 - [Customers](https://developer.squareup.com/explorer/square/customers-api/list-customers)
 - [Shifts](https://developer.squareup.com/reference/square/labor-api/search-shifts)
+- [Inventory](https://developer.squareup.com/reference/square/inventory-api/batch-retrieve-inventory-counts)
 - [Orders](https://developer.squareup.com/reference/square/orders-api/search-orders)
 - [Cash drawers](https://developer.squareup.com/explorer/square/cash-drawers-api/list-cash-drawer-shifts)
 
@@ -98,6 +99,7 @@ Exponential [Backoff](https://developer.squareup.com/forums/t/current-square-api
 
 | Version | Date       | Pull Request                                             | Subject                                                                   |
 | :------ |:-----------| :------------------------------------------------------- |:--------------------------------------------------------------------------|
+| 1.3.0   | 2023-10-12 | [31107](https://github.com/airbytehq/airbyte/pull/31107) | Add new stream Inventory                                                  |
 | 1.2.0   | 2023-10-10 | [31065](https://github.com/airbytehq/airbyte/pull/31065) | Add new stream Cash drawers shifts                                        |
 | 1.1.3   | 2023-10-10 | [30960](https://github.com/airbytehq/airbyte/pull/30960) | Update `airbyte-cdk` version to `>=0.51.31`                               |
 | 1.1.2   | 2023-07-10 | [28019](https://github.com/airbytehq/airbyte/pull/28019) | fix display order of spec fields                                          |