airbyte-source-iterable 0.7.2__tar.gz → 1.0.0__tar.gz

airbyte_source_iterable-1.0.0/.airbyte-pypi-readme.md

@@ -0,0 +1,7 @@
+# Iterable
+
+This package contains the Airbyte Iterable connector.
+
+Airbyte is open-source data movement for ELT pipelines and AI agents. It moves data from APIs, databases, and files to warehouses, lakes, and AI applications.
+
+Airbyte provides a catalog of 600+ connectors for APIs, databases, data warehouses, data lakes, and AI applications. Use this package with [PyAirbyte](https://docs.airbyte.com/developers/pyairbyte) to run the connector from Python.

airbyte_source_iterable-1.0.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: airbyte-source-iterable
+Version: 1.0.0
+Summary: Source implementation for Iterable.
+Home-page: https://airbyte.com
+License: ELv2
+Author: Airbyte
+Author-email: contact@airbyte.io
+Requires-Python: >=3.9,<3.12
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: airbyte-cdk (>=3,<4)
+Requires-Dist: pendulum (==2.1.2)
+Requires-Dist: python-dateutil (==2.8.2)
+Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/iterable
+Project-URL: Repository, https://github.com/airbytehq/airbyte
+Description-Content-Type: text/markdown
+
+# Iterable
+
+This package contains the Airbyte Iterable connector.
+
+Airbyte is open-source data movement for ELT pipelines and AI agents. It moves data from APIs, databases, and files to warehouses, lakes, and AI applications.
+
+Airbyte provides a catalog of 600+ connectors for APIs, databases, data warehouses, data lakes, and AI applications. Use this package with [PyAirbyte](https://docs.airbyte.com/developers/pyairbyte) to run the connector from Python.
+

{airbyte_source_iterable-0.7.2 → airbyte_source_iterable-1.0.0}/pyproject.toml

@@ -3,12 +3,12 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "0.7.2"
+version = "1.0.0"
 name = "airbyte-source-iterable"
 description = "Source implementation for Iterable."
 authors = [ "Airbyte <contact@airbyte.io>",]
 license = "ELv2"
-readme = "README.md"
+readme = ".airbyte-pypi-readme.md"
 documentation = "https://docs.airbyte.com/integrations/sources/iterable"
 homepage = "https://airbyte.com"
 repository = "https://github.com/airbytehq/airbyte"

airbyte_source_iterable-1.0.0/source_iterable/components.py

@@ -0,0 +1,126 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from dataclasses import dataclass
+from datetime import datetime
+from typing import Any, Iterable, Mapping
+
+import requests
+
+from airbyte_cdk.sources.declarative.extractors.dpath_extractor import DpathExtractor
+
+
+@dataclass
+class EventsRecordExtractor(DpathExtractor):
+    common_fields = ("itblInternal", "_type", "createdAt", "email")
+
+    def extract_records(self, response: requests.Response) -> Iterable[Mapping[str, Any]]:
+        jsonl_records = super().extract_records(response=response)
+        for record_dict in jsonl_records:
+            record_dict_common_fields = {}
+            for field in self.common_fields:
+                record_dict_common_fields[field] = record_dict.pop(field, None)
+            yield {**record_dict_common_fields, "data": record_dict}
+
+
+@dataclass
+class UsersRecordExtractor(DpathExtractor):
+    """Extracts user records, keeping standard Iterable-managed fields at the top level
+    and placing all custom/tenant-specific dataFields into a generic `data` object.
+
+    Standard fields are those documented at:
+    https://support.iterable.com/hc/en-us/articles/217744303-User-Profile-Fields-Used-by-Iterable
+
+    The Iterable export API flattens nested objects into dotted keys (e.g.
+    `itblInternal.emailDomain`), so Iterable-internal fields are listed in their flat
+    dotted form. Keys not listed here - including Iterable-internal dotted keys that
+    are not declared in the stream schema - are routed into `data` so destinations
+    that materialize only declared fields never drop them.
+    """
+
+    # Fields documented by Iterable as managed or used for sending messages.
+    # Reference: https://support.iterable.com/hc/en-us/articles/217744303
+    STANDARD_FIELDS = frozenset(
+        {
+            # Unique identifiers
+            "email",
+            "userId",
+            # Managed by Iterable
+            "emailListIds",
+            "itblUserId",
+            "knownLitigatorFilter",
+            "profileUpdatedAt",
+            "receivedSMSDisclaimer",
+            "signupDate",
+            "signupSource",
+            "subscribedMessageTypeIds",
+            "unsubscribedChannelIds",
+            "unsubscribedMessageTypeIds",
+            "userListIds",
+            # Geolocation fields populated by Iterable from the user's IP
+            "city",
+            "region",
+            # Fields used for sending messages
+            "country",
+            "devices",
+            "ip",
+            "locale",
+            "phoneNumber",
+            "profile",
+            "timeZone",
+            "whatsAppPhoneNumber",
+            # Iterable-internal fields (the export returns them as flat dotted keys)
+            "itblInternal.emailDomain",
+            "itblInternal.phoneCountry",
+            "itblInternal.phoneType",
+            "itblInternal.documentCreatedAt",
+            "itblInternal.documentUpdatedAt",
+            "itblInternal.isUnknownUser",
+            "itblDS.brandAffinityLabel",
+            "itblDS.predictiveGoals",
+        }
+    )
+
+    # The export API emits these as space-separated timestamps ("2021-04-14 16:52:31 +00:00")
+    # while the schema declares format: date-time (RFC3339); normalize so typed destinations
+    # do not null the values into _airbyte_meta.changes.
+    TIMESTAMP_FIELDS = (
+        "signupDate",
+        "profileUpdatedAt",
+        "itblInternal.documentCreatedAt",
+        "itblInternal.documentUpdatedAt",
+    )
+    _TIMESTAMP_FORMATS = (
+        "%Y-%m-%d %H:%M:%S %z",
+        "%Y-%m-%dT%H:%M:%S%z",
+        "%Y-%m-%d %H:%M:%S.%f %z",
+        "%Y-%m-%dT%H:%M:%S.%f%z",
+    )
+
+    @classmethod
+    def _normalize_timestamp(cls, value: Any) -> Any:
+        if not isinstance(value, str):
+            return value
+        for fmt in cls._TIMESTAMP_FORMATS:
+            try:
+                return datetime.strptime(value, fmt).isoformat()
+            except ValueError:
+                continue
+        return value
+
+    def extract_records(self, response: requests.Response) -> Iterable[Mapping[str, Any]]:
+        jsonl_records = super().extract_records(response=response)
+        for record_dict in jsonl_records:
+            standard: dict[str, Any] = {}
+            data: dict[str, Any] = {}
+            for key, value in record_dict.items():
+                if key in self.STANDARD_FIELDS:
+                    standard[key] = value
+                else:
+                    data[key] = value
+            for field in self.TIMESTAMP_FIELDS:
+                if field in standard:
+                    standard[field] = self._normalize_timestamp(standard[field])
+            standard["data"] = data
+            yield standard

{airbyte_source_iterable-0.7.2 → airbyte_source_iterable-1.0.0}/source_iterable/manifest.yaml

@@ -315,7 +315,7 @@ streams:
       record_selector:
         type: RecordSelector
         extractor:
-          type: DpathExtractor
+          class_name: source_iterable.components.UsersRecordExtractor
           field_path: []
       partition_router: []
     primary_key: []
@@ -344,6 +344,8 @@ streams:
       cursor_datetime_formats:
         - "%Y-%m-%d %H:%M:%S %z"
         - "%Y-%m-%dT%H:%M:%S%z"
+        - "%Y-%m-%d %H:%M:%S.%f %z"
+        - "%Y-%m-%dT%H:%M:%S.%f%z"
   - name: events
     primary_key: []
     retriever:

airbyte_source_iterable-1.0.0/source_iterable/schemas/users.json

@@ -0,0 +1,159 @@
+{
+  "properties": {
+    "email": {
+      "description": "User's email address (unique identifier).",
+      "type": ["null", "string"]
+    },
+    "userId": {
+      "description": "User's unique identifier assigned by the tenant.",
+      "type": ["null", "string"]
+    },
+    "emailListIds": {
+      "description": "List of static list IDs the user is a member of (email-based projects).",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "integer"]
+      }
+    },
+    "itblUserId": {
+      "description": "Iterable's internal unique user identifier.",
+      "type": ["null", "string"]
+    },
+    "knownLitigatorFilter": {
+      "description": "Known litigator confidence level (LT1, LT2, or LT3).",
+      "type": ["null", "string"]
+    },
+    "profileUpdatedAt": {
+      "description": "Date and time when the profile was last updated.",
+      "type": ["null", "string"],
+      "format": "date-time",
+      "airbyte_type": "timestamp_with_timezone"
+    },
+    "receivedSMSDisclaimer": {
+      "description": "Whether the user has received an SMS with opt-out instructions.",
+      "type": ["null", "boolean"]
+    },
+    "signupDate": {
+      "description": "Date and time when the user profile was created.",
+      "type": ["null", "string"],
+      "format": "date-time",
+      "airbyte_type": "timestamp_with_timezone"
+    },
+    "signupSource": {
+      "description": "How the contact was created in Iterable (e.g. API, IMPORT).",
+      "type": ["null", "string"]
+    },
+    "subscribedMessageTypeIds": {
+      "description": "List of opt-in message type IDs the user has subscribed to.",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "integer"]
+      }
+    },
+    "unsubscribedChannelIds": {
+      "description": "List of channel IDs the user has unsubscribed from.",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "integer"]
+      }
+    },
+    "unsubscribedMessageTypeIds": {
+      "description": "List of opt-out message type IDs the user has unsubscribed from.",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "integer"]
+      }
+    },
+    "userListIds": {
+      "description": "List of static list IDs the user is a member of (userId/hybrid projects).",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "integer"]
+      }
+    },
+    "country": {
+      "description": "User's country.",
+      "type": ["null", "string"]
+    },
+    "city": {
+      "description": "User's city, populated by Iterable from the user's IP address when the Overwrite Location Fields project setting is on.",
+      "type": ["null", "string"]
+    },
+    "region": {
+      "description": "User's region, populated by Iterable from the user's IP address when the Overwrite Location Fields project setting is on.",
+      "type": ["null", "string"]
+    },
+    "devices": {
+      "description": "Devices registered for push notifications.",
+      "type": ["null", "array"],
+      "items": {
+        "type": ["null", "object"]
+      }
+    },
+    "ip": {
+      "description": "User's IP address.",
+      "type": ["null", "string"]
+    },
+    "locale": {
+      "description": "User's locale.",
+      "type": ["null", "string"]
+    },
+    "phoneNumber": {
+      "description": "User's phone number used for SMS.",
+      "type": ["null", "string"]
+    },
+    "whatsAppPhoneNumber": {
+      "description": "User's phone number used as the recipient identifier for WhatsApp campaigns.",
+      "type": ["null", "string"]
+    },
+    "profile": {
+      "description": "Profile data used for message personalization.",
+      "type": ["null", "object"]
+    },
+    "timeZone": {
+      "description": "User's time zone.",
+      "type": ["null", "string"]
+    },
+    "itblInternal.emailDomain": {
+      "description": "Domain of the user's email address (managed by Iterable).",
+      "type": ["null", "string"]
+    },
+    "itblInternal.phoneCountry": {
+      "description": "ISO-3166 country code for the user's phone number.",
+      "type": ["null", "string"]
+    },
+    "itblInternal.phoneType": {
+      "description": "Type of phone number (MOBILE, FIXED_LINE, VOIP, etc.).",
+      "type": ["null", "string"]
+    },
+    "itblInternal.documentCreatedAt": {
+      "description": "Timestamp when the user document was created internally.",
+      "type": ["null", "string"],
+      "format": "date-time",
+      "airbyte_type": "timestamp_with_timezone"
+    },
+    "itblInternal.documentUpdatedAt": {
+      "description": "Timestamp when the user document was last updated internally.",
+      "type": ["null", "string"],
+      "format": "date-time",
+      "airbyte_type": "timestamp_with_timezone"
+    },
+    "itblInternal.isUnknownUser": {
+      "description": "Whether the user is flagged as unknown by Iterable.",
+      "type": ["null", "boolean"]
+    },
+    "itblDS.brandAffinityLabel": {
+      "description": "Contact's engagement level as determined by Brand Affinity.",
+      "type": ["null", "string"]
+    },
+    "itblDS.predictiveGoals": {
+      "description": "User conversion scores for Predictive Goals.",
+      "type": ["null", "object"]
+    },
+    "data": {
+      "description": "Custom data fields specific to the tenant. Contains all non-standard user profile fields.",
+      "type": ["null", "object"]
+    }
+  },
+  "type": ["null", "object"]
+}

airbyte_source_iterable-0.7.2/PKG-INFO

@@ -1,126 +0,0 @@
-Metadata-Version: 2.1
-Name: airbyte-source-iterable
-Version: 0.7.2
-Summary: Source implementation for Iterable.
-Home-page: https://airbyte.com
-License: ELv2
-Author: Airbyte
-Author-email: contact@airbyte.io
-Requires-Python: >=3.9,<3.12
-Classifier: License :: Other/Proprietary License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: airbyte-cdk (>=3,<4)
-Requires-Dist: pendulum (==2.1.2)
-Requires-Dist: python-dateutil (==2.8.2)
-Project-URL: Documentation, https://docs.airbyte.com/integrations/sources/iterable
-Project-URL: Repository, https://github.com/airbytehq/airbyte
-Description-Content-Type: text/markdown
-
-# Iterable source connector
-
-This is the repository for the Iterable source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/iterable).
-
-## Local development
-
-### Prerequisites
-
-- Python (~=3.9)
-- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
-
-### Installing the connector
-
-From this connector directory, run:
-
-```bash
-poetry install --with dev
-```
-
-### Create credentials
-
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/iterable)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_iterable/spec.yaml` file.
-Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
-See `sample_files/sample_config.json` for a sample config file.
-
-### Locally running the connector
-
-```
-poetry run source-iterable spec
-poetry run source-iterable check --config secrets/config.json
-poetry run source-iterable discover --config secrets/config.json
-poetry run source-iterable read --config secrets/config.json --catalog integration_tests/configured_catalog.json
-```
-
-### Running unit tests
-
-To run unit tests locally, from the connector directory run:
-
-```
-poetry run pytest unit_tests
-```
-
-### Building the docker image
-
-1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
-2. Run the following command to build the docker image:
-
-```bash
-airbyte-ci connectors --name=source-iterable build
-```
-
-An image will be available on your host with the tag `airbyte/source-iterable:dev`.
-
-### Running as a docker container
-
-Then run any of the connector commands as follows:
-
-```
-docker run --rm airbyte/source-iterable:dev spec
-docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-iterable:dev check --config /secrets/config.json
-docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-iterable:dev discover --config /secrets/config.json
-docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-iterable:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
-```
-
-### Running our CI test suite
-
-You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
-
-```bash
-airbyte-ci connectors --name=source-iterable test
-```
-
-### Customizing acceptance Tests
-
-Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
-If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
-
-### Dependency Management
-
-All of your dependencies should be managed via Poetry.
-To add a new dependency, run:
-
-```bash
-poetry add <package-name>
-```
-
-Please commit the changes to `pyproject.toml` and `poetry.lock` files.
-
-## Publishing a new version of the connector
-
-You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
-
-1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-iterable test`
-2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
-   - bump the `dockerImageTag` value in in `metadata.yaml`
-   - bump the `version` value in `pyproject.toml`
-3. Make sure the `metadata.yaml` content is up to date.
-4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/iterable.md`).
-5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
-6. Pat yourself on the back for being an awesome contributor.
-7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
-8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
-

airbyte_source_iterable-0.7.2/README.md

@@ -1,104 +0,0 @@
-# Iterable source connector
-
-This is the repository for the Iterable source connector, written in Python.
-For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/iterable).
-
-## Local development
-
-### Prerequisites
-
-- Python (~=3.9)
-- Poetry (~=1.7) - installation instructions [here](https://python-poetry.org/docs/#installation)
-
-### Installing the connector
-
-From this connector directory, run:
-
-```bash
-poetry install --with dev
-```
-
-### Create credentials
-
-**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/iterable)
-to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_iterable/spec.yaml` file.
-Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
-See `sample_files/sample_config.json` for a sample config file.
-
-### Locally running the connector
-
-```
-poetry run source-iterable spec
-poetry run source-iterable check --config secrets/config.json
-poetry run source-iterable discover --config secrets/config.json
-poetry run source-iterable read --config secrets/config.json --catalog integration_tests/configured_catalog.json
-```
-
-### Running unit tests
-
-To run unit tests locally, from the connector directory run:
-
-```
-poetry run pytest unit_tests
-```
-
-### Building the docker image
-
-1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
-2. Run the following command to build the docker image:
-
-```bash
-airbyte-ci connectors --name=source-iterable build
-```
-
-An image will be available on your host with the tag `airbyte/source-iterable:dev`.
-
-### Running as a docker container
-
-Then run any of the connector commands as follows:
-
-```
-docker run --rm airbyte/source-iterable:dev spec
-docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-iterable:dev check --config /secrets/config.json
-docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-iterable:dev discover --config /secrets/config.json
-docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-iterable:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
-```
-
-### Running our CI test suite
-
-You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):
-
-```bash
-airbyte-ci connectors --name=source-iterable test
-```
-
-### Customizing acceptance Tests
-
-Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
-If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
-
-### Dependency Management
-
-All of your dependencies should be managed via Poetry.
-To add a new dependency, run:
-
-```bash
-poetry add <package-name>
-```
-
-Please commit the changes to `pyproject.toml` and `poetry.lock` files.
-
-## Publishing a new version of the connector
-
-You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
-
-1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-iterable test`
-2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
-   - bump the `dockerImageTag` value in in `metadata.yaml`
-   - bump the `version` value in `pyproject.toml`
-3. Make sure the `metadata.yaml` content is up to date.
-4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/iterable.md`).
-5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
-6. Pat yourself on the back for being an awesome contributor.
-7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
-8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.

airbyte_source_iterable-0.7.2/source_iterable/components.py

@@ -1,23 +0,0 @@
-#
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
-#
-
-from dataclasses import dataclass
-from typing import Any, Iterable, Mapping
-
-import requests
-
-from airbyte_cdk.sources.declarative.extractors.dpath_extractor import DpathExtractor
-
-
-@dataclass
-class EventsRecordExtractor(DpathExtractor):
-    common_fields = ("itblInternal", "_type", "createdAt", "email")
-
-    def extract_records(self, response: requests.Response) -> Iterable[Mapping[str, Any]]:
-        jsonl_records = super().extract_records(response=response)
-        for record_dict in jsonl_records:
-            record_dict_common_fields = {}
-            for field in self.common_fields:
-                record_dict_common_fields[field] = record_dict.pop(field, None)
-            yield {**record_dict_common_fields, "data": record_dict}

airbyte_source_iterable-0.7.2/source_iterable/schemas/users.json

@@ -1,458 +0,0 @@
-{
-  "properties": {
-    "country": {
-      "description": "Country name.",
-      "type": ["null", "string"]
-    },
-    "firstOrderDate": {
-      "description": "Date and time of the first order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "addresses": {
-      "description": "List of addresses associated with the user",
-      "type": ["null", "array"],
-      "items": {
-        "type": ["null", "object"],
-        "properties": {
-          "first_name": {
-            "description": "First name of the user associated with the address.",
-            "type": ["null", "string"]
-          },
-          "city": {
-            "description": "City name.",
-            "type": ["null", "string"]
-          },
-          "name": {
-            "description": "Full name associated with the address.",
-            "type": ["null", "string"]
-          },
-          "zip": {
-            "description": "Postal code or ZIP code.",
-            "type": ["null", "string"]
-          },
-          "country": {
-            "description": "Country name of the address.",
-            "type": ["null", "string"]
-          },
-          "address1": {
-            "description": "Address line 1.",
-            "type": ["null", "string"]
-          },
-          "address2": {
-            "description": "Address line 2.",
-            "type": ["null", "string"]
-          },
-          "company": {
-            "description": "Company name associated with the address.",
-            "type": ["null", "string"]
-          },
-          "country_code": {
-            "description": "Country code of the address.",
-            "type": ["null", "string"]
-          },
-          "default": {
-            "description": "Indicates if this is the default address.",
-            "type": ["null", "boolean"]
-          },
-          "id": {
-            "description": "Unique identifier for the address.",
-            "type": ["null", "string"]
-          },
-          "last_name": {
-            "description": "Last name of the user associated with the address.",
-            "type": ["null", "string"]
-          },
-          "province": {
-            "description": "Province or state of the address.",
-            "type": ["null", "string"]
-          },
-          "province_code": {
-            "description": "Province or state code of the address.",
-            "type": ["null", "string"]
-          },
-          "country_name": {
-            "description": "Full name of the country.",
-            "type": ["null", "string"]
-          },
-          "phone": {
-            "description": "Contact phone number.",
-            "type": ["null", "string"]
-          }
-        }
-      }
-    },
-    "emailAcquiredDate": {
-      "description": "Date and time when the email was acquired.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "emailSegmentStatus": {
-      "description": "Status of the email segment.",
-      "type": ["null", "string"]
-    },
-    "admin_graphql_api_id": {
-      "description": "Admin GraphQL API ID.",
-      "type": ["null", "string"]
-    },
-    "id": {
-      "description": "User ID.",
-      "type": ["null", "string"]
-    },
-    "mostRecentEmailList": {
-      "description": "Most recent email list the user is part of.",
-      "type": ["null", "string"]
-    },
-    "mostRecentEmailSegment": {
-      "description": "Most recent email segment the user is part of.",
-      "type": ["null", "string"]
-    },
-    "aov": {
-      "description": "Average order value.",
-      "type": ["null", "number"]
-    },
-    "firstCampaign": {
-      "description": "First campaign the user interacted with.",
-      "type": ["null", "string"]
-    },
-    "thirdMostRecentOrderDate": {
-      "description": "Date and time of the third most recent order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "firstPurchaseDate": {
-      "description": "Date and time of the first purchase made by the user.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "firstMedium": {
-      "description": "First medium through which the user interacted.",
-      "type": ["null", "string"]
-    },
-    "default_address": {
-      "description": "Default address of the user",
-      "type": ["null", "object"],
-      "properties": {
-        "first_name": {
-          "description": "First name of the user associated with the address.",
-          "type": ["null", "string"]
-        },
-        "city": {
-          "description": "City name.",
-          "type": ["null", "string"]
-        },
-        "name": {
-          "description": "Full name associated with the address.",
-          "type": ["null", "string"]
-        },
-        "zip": {
-          "description": "Postal code or ZIP code.",
-          "type": ["null", "string"]
-        },
-        "country": {
-          "description": "Country name of the address.",
-          "type": ["null", "string"]
-        },
-        "address2": {
-          "description": "Address line 2.",
-          "type": ["null", "string"]
-        },
-        "company": {
-          "description": "Company name associated with the address.",
-          "type": ["null", "string"]
-        },
-        "country_code": {
-          "description": "Country code of the address.",
-          "type": ["null", "string"]
-        },
-        "id": {
-          "description": "Unique identifier for the address.",
-          "type": ["null", "string"]
-        },
-        "last_name": {
-          "description": "Last name of the user associated with the address.",
-          "type": ["null", "string"]
-        },
-        "address1": {
-          "description": "Address line 1.",
-          "type": ["null", "string"]
-        },
-        "default": {
-          "description": "Indicates if this is the default address.",
-          "type": ["null", "boolean"]
-        },
-        "province": {
-          "description": "Province or state of the address.",
-          "type": ["null", "string"]
-        },
-        "province_code": {
-          "description": "Province or state code of the address.",
-          "type": ["null", "string"]
-        },
-        "country_name": {
-          "description": "Full name of the country.",
-          "type": ["null", "string"]
-        },
-        "phone": {
-          "description": "Contact phone number.",
-          "type": ["null", "string"]
-        }
-      }
-    },
-    "emailListIds": {
-      "description": "List of email list IDs subscribed by the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "IDs of the email lists associated with the user."
-      }
-    },
-    "accepts_marketing": {
-      "description": "Indicates whether the user has consented to receive marketing communications.",
-      "type": ["null", "boolean"]
-    },
-    "secondMostRecentOrderDate": {
-      "description": "Date and time of the second most recent order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "state": {
-      "description": "State name.",
-      "type": ["null", "string"]
-    },
-    "mostRecentCampaign": {
-      "description": "Most recent campaign the user interacted with.",
-      "type": ["null", "string"]
-    },
-    "zip": {
-      "description": "Postal code or ZIP code.",
-      "type": ["null", "string"]
-    },
-    "total_spent": {
-      "description": "Total amount spent by the user.",
-      "type": ["null", "number"]
-    },
-    "mostRecentOrderDate": {
-      "description": "Date and time of the most recent order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "last_order_id": {
-      "description": "ID of the user's last order.",
-      "type": ["null", "string"]
-    },
-    "tax_exempt": {
-      "description": "Indicates if the user is tax exempt.",
-      "type": ["null", "boolean"]
-    },
-    "mostRecentSource": {
-      "description": "Most recent source of user interaction.",
-      "type": ["null", "string"]
-    },
-    "twelveMonthLtr": {
-      "description": "Lifetime total revenue for the past twelve months.",
-      "type": ["null", "integer"]
-    },
-    "verified_email": {
-      "description": "Indicates if the user's email address is verified.",
-      "type": ["null", "boolean"]
-    },
-    "mostRecentMedium": {
-      "description": "Most recent medium of user interaction.",
-      "type": ["null", "string"]
-    },
-    "orders_count": {
-      "description": "Total number of orders made by the user.",
-      "type": ["null", "integer"]
-    },
-    "firstName": {
-      "description": "User's first name.",
-      "type": ["null", "string"]
-    },
-    "lastInteractionTs": {
-      "description": "Date and time of the last interaction with the user.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "boughtSas": {
-      "description": "Indicates if the user has purchased a specific product or service.",
-      "type": ["null", "boolean"]
-    },
-    "secondMostRecentOrderCards": {
-      "description": "Details of the second most recent order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the second most recent order cards."
-      }
-    },
-    "unsubscribedChannelIds": {
-      "description": "List of channel IDs the user has unsubscribed from",
-      "type": ["null", "array"],
-      "items": {
-        "description": "IDs of the channels from which the user unsubscribed."
-      }
-    },
-    "lastName": {
-      "description": "User's last name.",
-      "type": ["null", "string"]
-    },
-    "last_order_name": {
-      "description": "Name of the user's last order.",
-      "type": ["null", "string"]
-    },
-    "secondOrderDate": {
-      "description": "Date and time of the second order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "hasAccount": {
-      "description": "Indicates if the user has an account.",
-      "type": ["null", "boolean"]
-    },
-    "city": {
-      "description": "City name.",
-      "type": ["null", "string"]
-    },
-    "mostRecentOrderCards": {
-      "description": "Details of the most recent order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the most recent order cards."
-      }
-    },
-    "itblInternal": {
-      "description": "Internal details specific to the platform",
-      "type": ["null", "object"],
-      "properties": {
-        "emailDomain": {
-          "description": "Domain of the user's email address.",
-          "type": ["null", "string"]
-        },
-        "documentUpdatedAt": {
-          "description": "Date and time when the document was last updated.",
-          "type": ["null", "string"],
-          "format": "date-time"
-        },
-        "documentCreatedAt": {
-          "description": "Date and time when the document was created.",
-          "type": ["null", "string"],
-          "format": "date-time"
-        }
-      }
-    },
-    "hasReminder": {
-      "description": "Indicates if the user has set a reminder.",
-      "type": ["null", "boolean"]
-    },
-    "thirdOrderDate": {
-      "description": "Date and time of the third order.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "subscribedMessageTypeIds": {
-      "description": "List of message type IDs user has subscribed to",
-      "type": ["null", "array"],
-      "items": {
-        "description": "IDs of the message types the user is subscribed to."
-      }
-    },
-    "firstSource": {
-      "description": "First source of user interaction.",
-      "type": ["null", "string"]
-    },
-    "unsubscribedMessageTypeIds": {
-      "description": "List of message type IDs the user has unsubscribed from",
-      "type": ["null", "array"],
-      "items": {
-        "description": "IDs of the message types from which the user unsubscribed."
-      }
-    },
-    "first_name": {
-      "description": "User's first name.",
-      "type": ["null", "string"]
-    },
-    "email": {
-      "description": "User's email address.",
-      "type": ["null", "string"]
-    },
-    "thirdMostRecentOrderCards": {
-      "description": "Details of the third most recent order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the third most recent order cards."
-      }
-    },
-    "profileUpdatedAt": {
-      "description": "Date and time when the profile was last updated.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "signupDate": {
-      "description": "Date and time when the user signed up.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "businessLines": {
-      "description": "List of business lines the user is associated with",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Business lines associated with the user."
-      }
-    },
-    "secondOrderCards": {
-      "description": "Details of the second order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the second order cards."
-      }
-    },
-    "address1": {
-      "description": "Primary address line of the user.",
-      "type": ["null", "string"]
-    },
-    "last_name": {
-      "description": "User's last name.",
-      "type": ["null", "string"]
-    },
-    "ltr": {
-      "description": "Lifetime total revenue.",
-      "type": ["null", "integer"]
-    },
-    "userId": {
-      "description": "User's unique identifier.",
-      "type": ["null", "string"]
-    },
-    "shopify_created_at": {
-      "description": "Date and time when the user was created in Shopify.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    },
-    "signupSource": {
-      "description": "Source through which the user signed up.",
-      "type": ["null", "string"]
-    },
-    "thirdOrderCards": {
-      "description": "Details of the third order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the third order cards."
-      }
-    },
-    "firstOrderCards": {
-      "description": "Details of the first order cards related to the user",
-      "type": ["null", "array"],
-      "items": {
-        "description": "Details of the first order cards."
-      }
-    },
-    "totalOrders": {
-      "description": "Total number of orders made by the user.",
-      "type": ["null", "integer"]
-    },
-    "shopify_updated_at": {
-      "description": "Date and time when the user was last updated in Shopify.",
-      "type": ["null", "string"],
-      "format": "date-time"
-    }
-  },
-  "type": ["null", "object"]
-}