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

{airbyte_source_iterable-0.7.1 → airbyte_source_iterable-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-iterable
-Version: 0.7.1
+Version: 0.7.2
 Summary: Source implementation for Iterable.
 Home-page: https://airbyte.com
 License: ELv2

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

@@ -3,7 +3,7 @@ requires = [ "poetry-core>=1.0.0",]
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "0.7.1"
+version = "0.7.2"
 name = "airbyte-source-iterable"
 description = "Source implementation for Iterable."
 authors = [ "Airbyte <contact@airbyte.io>",]

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

@@ -21,12 +21,22 @@ spec:
         type: "string"
         title: "Start Date"
         description: >-
-          The date from which you'd like to replicate data for Iterable, in the format YYYY-MM-DDT00:00:00Z. 
+          The date from which you'd like to replicate data for Iterable, in the format YYYY-MM-DDT00:00:00Z.
           All data generated after this date will be replicated.
         examples: ["2021-04-01T00:00:00Z"]
         pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$
         order: 1
         format: "date-time"
+      region:
+        type: "string"
+        title: "Region"
+        description: >-
+          The region where your Iterable account is hosted. Select 'EU' if your account is on the European data center.
+        enum:
+          - US
+          - EU
+        default: "US"
+        order: 2
       lookback_window:
         type: "integer"
         title: "Lookback Window (Minutes)"
@@ -38,7 +48,7 @@ spec:
         default: 5
         minimum: 0
         examples: [5, 10, 15]
-        order: 2
+        order: 3
 type: DeclarativeSource
 check:
   type: CheckStream
@@ -54,7 +64,7 @@ streams:
       requester:
         path: lists
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -86,7 +96,7 @@ streams:
       requester:
         path: lists/getUsers
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -122,7 +132,7 @@ streams:
                   type: SimpleRetriever
                   requester:
                     type: HttpRequester
-                    url_base: https://api.iterable.com/api/
+                    url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
                     path: lists
                     http_method: GET
                     request_parameters: {}
@@ -167,7 +177,7 @@ streams:
       requester:
         path: campaigns
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -197,7 +207,7 @@ streams:
       requester:
         path: channels
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -227,7 +237,7 @@ streams:
       requester:
         path: messageTypes
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -257,7 +267,7 @@ streams:
       requester:
         path: metadata
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -288,7 +298,7 @@ streams:
       requester:
         path: export/data.json
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         http_method: GET
         authenticator:
           type: ApiKeyAuthenticator
@@ -342,7 +352,7 @@ streams:
         type: JsonlDecoder
       requester:
         type: HttpRequester
-        url_base: https://api.iterable.com/api/
+        url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
         path: export/userEvents
         http_method: GET
         request_parameters:
@@ -385,7 +395,7 @@ streams:
                   requester:
                     path: lists/getUsers
                     type: HttpRequester
-                    url_base: https://api.iterable.com/api/
+                    url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
                     http_method: GET
                     authenticator:
                       type: ApiKeyAuthenticator
@@ -421,7 +431,7 @@ streams:
                               type: SimpleRetriever
                               requester:
                                 type: HttpRequester
-                                url_base: https://api.iterable.com/api/
+                                url_base: "{{ 'https://api.eu.iterable.com/api/' if config.get('region', 'US') == 'EU' else 'https://api.iterable.com/api/' }}"
                                 path: lists
                                 http_method: GET
                                 request_parameters: {}

airbyte_source_iterable-0.7.2/source_iterable/source.py

@@ -0,0 +1,117 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+from typing import Any, List, Mapping
+
+from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource
+from airbyte_cdk.sources.streams import Stream
+from airbyte_cdk.sources.streams.http.requests_native_auth import TokenAuthenticator
+
+from .streams import (
+    CampaignsMetrics,
+    CustomEvent,
+    EmailBounce,
+    EmailClick,
+    EmailComplaint,
+    EmailOpen,
+    EmailSend,
+    EmailSendSkip,
+    EmailSubscribe,
+    EmailUnsubscribe,
+    HostedUnsubscribeClick,
+    InAppClick,
+    InAppClose,
+    InAppDelete,
+    InAppDelivery,
+    InAppOpen,
+    InAppSend,
+    InAppSendSkip,
+    InboxMessageImpression,
+    InboxSession,
+    Purchase,
+    PushBounce,
+    PushOpen,
+    PushSend,
+    PushSendSkip,
+    PushUninstall,
+    SmsBounce,
+    SmsClick,
+    SmsReceived,
+    SmsSend,
+    SmsSendSkip,
+    SmsUsageInfo,
+    Templates,
+    WebPushClick,
+    WebPushSend,
+    WebPushSendSkip,
+)
+
+
+"""
+This file provides the necessary constructs to interpret a provided declarative YAML configuration file into
+source connector.
+
+WARNING: Do not modify this file.
+"""
+
+
+# Declarative Source
+class SourceIterable(YamlDeclarativeSource):
+    def __init__(self):
+        super().__init__(**{"path_to_yaml": "manifest.yaml"})
+
+    def streams(self, config: Mapping[str, Any]) -> List[Stream]:
+        streams = super().streams(config=config)
+
+        authenticator = TokenAuthenticator(token=config["api_key"], auth_header="Api-Key", auth_method="")
+        # end date is provided for integration tests only
+        start_date, end_date = config["start_date"], config.get("end_date")
+        lookback_window = config.get("lookback_window", 5)
+        date_range = {"start_date": start_date, "end_date": end_date, "lookback_window": lookback_window}
+        # CampaignsMetrics extends IterableStream (not IterableExportStream) and does not accept lookback_window
+        campaigns_date_range = {"start_date": start_date, "end_date": end_date}
+        region = config.get("region", "US")
+
+        # TODO: migrate streams below to low code as slicer logic will be migrated to generator based
+        streams.extend(
+            [
+                CampaignsMetrics(authenticator=authenticator, region=region, **campaigns_date_range),
+                Templates(authenticator=authenticator, region=region, **date_range),
+                EmailBounce(authenticator=authenticator, region=region, **date_range),
+                EmailClick(authenticator=authenticator, region=region, **date_range),
+                EmailComplaint(authenticator=authenticator, region=region, **date_range),
+                EmailOpen(authenticator=authenticator, region=region, **date_range),
+                EmailSend(authenticator=authenticator, region=region, **date_range),
+                EmailSendSkip(authenticator=authenticator, region=region, **date_range),
+                EmailSubscribe(authenticator=authenticator, region=region, **date_range),
+                EmailUnsubscribe(authenticator=authenticator, region=region, **date_range),
+                PushSend(authenticator=authenticator, region=region, **date_range),
+                PushSendSkip(authenticator=authenticator, region=region, **date_range),
+                PushOpen(authenticator=authenticator, region=region, **date_range),
+                PushUninstall(authenticator=authenticator, region=region, **date_range),
+                PushBounce(authenticator=authenticator, region=region, **date_range),
+                WebPushSend(authenticator=authenticator, region=region, **date_range),
+                WebPushClick(authenticator=authenticator, region=region, **date_range),
+                WebPushSendSkip(authenticator=authenticator, region=region, **date_range),
+                InAppSend(authenticator=authenticator, region=region, **date_range),
+                InAppOpen(authenticator=authenticator, region=region, **date_range),
+                InAppClick(authenticator=authenticator, region=region, **date_range),
+                InAppClose(authenticator=authenticator, region=region, **date_range),
+                InAppDelete(authenticator=authenticator, region=region, **date_range),
+                InAppDelivery(authenticator=authenticator, region=region, **date_range),
+                InAppSendSkip(authenticator=authenticator, region=region, **date_range),
+                InboxSession(authenticator=authenticator, region=region, **date_range),
+                InboxMessageImpression(authenticator=authenticator, region=region, **date_range),
+                SmsSend(authenticator=authenticator, region=region, **date_range),
+                SmsBounce(authenticator=authenticator, region=region, **date_range),
+                SmsClick(authenticator=authenticator, region=region, **date_range),
+                SmsReceived(authenticator=authenticator, region=region, **date_range),
+                SmsSendSkip(authenticator=authenticator, region=region, **date_range),
+                SmsUsageInfo(authenticator=authenticator, region=region, **date_range),
+                Purchase(authenticator=authenticator, region=region, **date_range),
+                CustomEvent(authenticator=authenticator, region=region, **date_range),
+                HostedUnsubscribeClick(authenticator=authenticator, region=region, **date_range),
+            ]
+        )
+        return streams

{airbyte_source_iterable-0.7.1 → airbyte_source_iterable-0.7.2}/source_iterable/spec.json

@@ -22,6 +22,14 @@
         "order": 1,
         "format": "date-time"
       },
+      "region": {
+        "type": "string",
+        "title": "Region",
+        "description": "The region where your Iterable account is hosted. Select 'EU' if your account is on the European data center.",
+        "enum": ["US", "EU"],
+        "default": "US",
+        "order": 2
+      },
       "lookback_window": {
         "type": "integer",
         "title": "Lookback Window (Minutes)",
@@ -29,7 +37,7 @@
         "default": 5,
         "minimum": 0,
         "examples": [5, 10, 15],
-        "order": 2
+        "order": 3
       }
     }
   }

{airbyte_source_iterable-0.7.1 → airbyte_source_iterable-0.7.2}/source_iterable/streams.py

@@ -33,14 +33,20 @@ class IterableStream(HttpStream, ABC):
     # to prevent 429 error on other streams
     ignore_further_slices = False
 
-    url_base = "https://api.iterable.com/api/"
     primary_key = "id"
 
-    def __init__(self, authenticator):
+    def __init__(self, authenticator, region: str = "US"):
         self._cred = authenticator
         self._slice_retry = 0
+        self._region = region
         super().__init__(authenticator)
 
+    @property
+    def url_base(self) -> str:
+        if self._region == "EU":
+            return "https://api.eu.iterable.com/api/"
+        return "https://api.iterable.com/api/"
+
     @property
     def retry_factor(self) -> int:
         return 20
@@ -407,7 +413,7 @@ class CampaignsMetrics(IterableStream):
         return params
 
     def stream_slices(self, **kwargs) -> Iterable[Optional[Mapping[str, any]]]:
-        lists = Campaigns(authenticator=self._cred)
+        lists = Campaigns(authenticator=self._cred, region=self._region)
         campaign_ids = []
         for list_record in lists.read_records(sync_mode=kwargs.get("sync_mode", SyncMode.full_refresh)):
             campaign_ids.append(list_record["id"])

airbyte_source_iterable-0.7.1/source_iterable/source.py

@@ -1,116 +0,0 @@
-#
-# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
-#
-
-from typing import Any, List, Mapping
-
-from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource
-from airbyte_cdk.sources.streams import Stream
-from airbyte_cdk.sources.streams.http.requests_native_auth import TokenAuthenticator
-
-from .streams import (
-    CampaignsMetrics,
-    CustomEvent,
-    EmailBounce,
-    EmailClick,
-    EmailComplaint,
-    EmailOpen,
-    EmailSend,
-    EmailSendSkip,
-    EmailSubscribe,
-    EmailUnsubscribe,
-    HostedUnsubscribeClick,
-    InAppClick,
-    InAppClose,
-    InAppDelete,
-    InAppDelivery,
-    InAppOpen,
-    InAppSend,
-    InAppSendSkip,
-    InboxMessageImpression,
-    InboxSession,
-    Purchase,
-    PushBounce,
-    PushOpen,
-    PushSend,
-    PushSendSkip,
-    PushUninstall,
-    SmsBounce,
-    SmsClick,
-    SmsReceived,
-    SmsSend,
-    SmsSendSkip,
-    SmsUsageInfo,
-    Templates,
-    WebPushClick,
-    WebPushSend,
-    WebPushSendSkip,
-)
-
-
-"""
-This file provides the necessary constructs to interpret a provided declarative YAML configuration file into
-source connector.
-
-WARNING: Do not modify this file.
-"""
-
-
-# Declarative Source
-class SourceIterable(YamlDeclarativeSource):
-    def __init__(self):
-        super().__init__(**{"path_to_yaml": "manifest.yaml"})
-
-    def streams(self, config: Mapping[str, Any]) -> List[Stream]:
-        streams = super().streams(config=config)
-
-        authenticator = TokenAuthenticator(token=config["api_key"], auth_header="Api-Key", auth_method="")
-        # end date is provided for integration tests only
-        start_date, end_date = config["start_date"], config.get("end_date")
-        lookback_window = config.get("lookback_window", 5)
-        date_range = {"start_date": start_date, "end_date": end_date, "lookback_window": lookback_window}
-        # CampaignsMetrics extends IterableStream (not IterableExportStream) and does not accept lookback_window
-        campaigns_date_range = {"start_date": start_date, "end_date": end_date}
-
-        # TODO: migrate streams below to low code as slicer logic will be migrated to generator based
-        streams.extend(
-            [
-                CampaignsMetrics(authenticator=authenticator, **campaigns_date_range),
-                Templates(authenticator=authenticator, **date_range),
-                EmailBounce(authenticator=authenticator, **date_range),
-                EmailClick(authenticator=authenticator, **date_range),
-                EmailComplaint(authenticator=authenticator, **date_range),
-                EmailOpen(authenticator=authenticator, **date_range),
-                EmailSend(authenticator=authenticator, **date_range),
-                EmailSendSkip(authenticator=authenticator, **date_range),
-                EmailSubscribe(authenticator=authenticator, **date_range),
-                EmailUnsubscribe(authenticator=authenticator, **date_range),
-                PushSend(authenticator=authenticator, **date_range),
-                PushSendSkip(authenticator=authenticator, **date_range),
-                PushOpen(authenticator=authenticator, **date_range),
-                PushUninstall(authenticator=authenticator, **date_range),
-                PushBounce(authenticator=authenticator, **date_range),
-                WebPushSend(authenticator=authenticator, **date_range),
-                WebPushClick(authenticator=authenticator, **date_range),
-                WebPushSendSkip(authenticator=authenticator, **date_range),
-                InAppSend(authenticator=authenticator, **date_range),
-                InAppOpen(authenticator=authenticator, **date_range),
-                InAppClick(authenticator=authenticator, **date_range),
-                InAppClose(authenticator=authenticator, **date_range),
-                InAppDelete(authenticator=authenticator, **date_range),
-                InAppDelivery(authenticator=authenticator, **date_range),
-                InAppSendSkip(authenticator=authenticator, **date_range),
-                InboxSession(authenticator=authenticator, **date_range),
-                InboxMessageImpression(authenticator=authenticator, **date_range),
-                SmsSend(authenticator=authenticator, **date_range),
-                SmsBounce(authenticator=authenticator, **date_range),
-                SmsClick(authenticator=authenticator, **date_range),
-                SmsReceived(authenticator=authenticator, **date_range),
-                SmsSendSkip(authenticator=authenticator, **date_range),
-                SmsUsageInfo(authenticator=authenticator, **date_range),
-                Purchase(authenticator=authenticator, **date_range),
-                CustomEvent(authenticator=authenticator, **date_range),
-                HostedUnsubscribeClick(authenticator=authenticator, **date_range),
-            ]
-        )
-        return streams