airbyte-source-iterable 0.4.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

{airbyte_source_iterable-0.4.0.dist-info → airbyte_source_iterable-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-iterable
-Version: 0.4.0
+Version: 0.5.1
 Summary: Source implementation for Iterable.
 Home-page: https://airbyte.com
 License: MIT
@@ -12,7 +12,7 @@ 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 (>=0,<1)
+Requires-Dist: airbyte-cdk (==0.80.0)
 Requires-Dist: pendulum (==2.1.2)
 Requires-Dist: python-dateutil (==2.8.2)
 Requires-Dist: requests (==2.31.0)

airbyte_source_iterable-0.5.1.dist-info/RECORD

@@ -0,0 +1,31 @@
+source_iterable/__init__.py,sha256=8WKQT800ggxG1vGPoA_ZHUkozwEM7qMhGMhzEPCdA4o,65
+source_iterable/components.py,sha256=dHp23THc43TmogP_tCxcv12mAgZSRs5fKir2ckr4hHI,1374
+source_iterable/manifest.yaml,sha256=uO7z-bIU6CtGms6IsLwjyZ-cb3tVY-vLUMLOZGkZDts,13996
+source_iterable/run.py,sha256=-Bvz772Z7iJWExDoJS7chxv725hG4e9e5Engrtp66iE,236
+source_iterable/schemas/campaigns.json,sha256=FONoPuz_4aRat8OZzhj7BcHFAqetpBYUDmOZfroCu7I,2494
+source_iterable/schemas/campaigns_metrics.json,sha256=Aa6pNdVxHOG-LSxlLzhxFY8uIdfrPBTgX9QyWrLJ4Fs,168
+source_iterable/schemas/channels.json,sha256=hgH6VJRvv_cFhWt-oQvoCLD-aOy4QRb9uFKAnuiQj6w,605
+source_iterable/schemas/email_bounce.json,sha256=6HKfaL06RNpedqxf7jHBC75dbpBfLx--7nWR3JiB7eg,1755
+source_iterable/schemas/email_click.json,sha256=A0L6JH1Kfgnpj4Wa-50OyqHyGEWH9tfJvoFGrrCN42Y,2749
+source_iterable/schemas/email_complaint.json,sha256=lM20rsQiIQ810zgG0zVKl34FyspUTfCp8b_aGPJp2rA,1704
+source_iterable/schemas/email_open.json,sha256=efYIpHb6vShC_LalRT26-x8Kx_BSuaevzThnX9N_tNE,2257
+source_iterable/schemas/email_send.json,sha256=UQ7ZYCdhn9A4tYpyHoMGy7JLIOF9VLz7Xgw-q6mg_Aw,5994
+source_iterable/schemas/email_send_skip.json,sha256=Fl4p-QFMDEDDb2JjfkfEGkcsav1Ak7nqkVTCvVd7cKA,6124
+source_iterable/schemas/email_subscribe.json,sha256=rLkVbvkd6v521zyDQzV7Ji7DVTGpzgbiXzMngQq55J8,1773
+source_iterable/schemas/email_unsubscribe.json,sha256=KBPOA5dauT7Ldk-OoJQEVzDlJZRaKiDrVJPVbBaGAsU,2665
+source_iterable/schemas/events.json,sha256=Pp5U47p4rIepPVq8vH4WLFJzqFnB1LovCK_c9HN-BtQ,1193
+source_iterable/schemas/list_users.json,sha256=7XvNCMxgM6ViEY0rvBu31JgongagVy9ciRBkt5J94TE,307
+source_iterable/schemas/lists.json,sha256=3DRUaV2vrQqSJ_uWIzTpAvrJTNNXaWU64yFw9INCuoQ,521
+source_iterable/schemas/message_types.json,sha256=DmbunfoTVfBjF6UVpCKJi0KbIXV2Lk4sp2t2WlXtfc8,437
+source_iterable/schemas/metadata.json,sha256=ioQcAKtObfsY-TonvGA75Q0BJwD7oBNgRAdD7O2PJvk,158
+source_iterable/schemas/templates.json,sha256=TLKmKP0qS18umiGHuS1MZ2Wh_vvxF1XuMAIfKpbgFyU,1156
+source_iterable/schemas/users.json,sha256=CHqA30cnsTXfI-M0n54NwVaaZEO12tt_IgQ9yPHNcXU,14569
+source_iterable/slice_generators.py,sha256=neRuWD52Xnr84KvWQ0kjaErR44sOKjxIyLCNeofohzE,6482
+source_iterable/source.py,sha256=AhZQ4L54VTo6jf2QltvFCqDNgqaPSEKCfR0GInCLEEc,4537
+source_iterable/spec.json,sha256=y5_YFTkPPtxjvzGtaZZql90Tc37fyZZpQKXFGPL_cYE,1009
+source_iterable/streams.py,sha256=ZEC8IqBrTeD2oYOvLL51E62iOsIOK3jiTN7pLI-CwRs,19468
+source_iterable/utils.py,sha256=2oM8AjBZXs9nTG_PhSWmxBWEmp-w-tWFaxQQvAfUuMM,649
+airbyte_source_iterable-0.5.1.dist-info/METADATA,sha256=uAZc_ji5dOSIM6JcTRA92z8cJek8fvxxieqBCy6nn0w,5352
+airbyte_source_iterable-0.5.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+airbyte_source_iterable-0.5.1.dist-info/entry_points.txt,sha256=pjzrNtsOX3jW37IK0U5pSmLiraiuLTPr5aB5-hBXpAo,59
+airbyte_source_iterable-0.5.1.dist-info/RECORD,,

source_iterable/components.py

@@ -0,0 +1,41 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+import json
+from dataclasses import dataclass
+from io import StringIO
+
+import requests
+from airbyte_cdk.sources.declarative.extractors.dpath_extractor import DpathExtractor
+from airbyte_cdk.sources.declarative.types import Config, Record, StreamSlice, StreamState
+
+
+@dataclass
+class XJsonRecordExtractor(DpathExtractor):
+    def extract_records(self, response: requests.Response) -> list[Record]:
+        return [json.loads(record) for record in response.iter_lines()]
+
+
+@dataclass
+class ListUsersRecordExtractor(DpathExtractor):
+    def extract_records(self, response: requests.Response) -> list[Record]:
+        return [{"email": record.decode()} for record in response.iter_lines()]
+
+
+@dataclass
+class EventsRecordExtractor(DpathExtractor):
+    common_fields = ("itblInternal", "_type", "createdAt", "email")
+
+    def extract_records(self, response: requests.Response) -> list[Record]:
+        jsonl_records = StringIO(response.text)
+        records = []
+        for record in jsonl_records:
+            record_dict = json.loads(record)
+            record_dict_common_fields = {}
+            for field in self.common_fields:
+                record_dict_common_fields[field] = record_dict.pop(field, None)
+
+            records.append({**record_dict_common_fields, "data": record_dict})
+
+        return records

source_iterable/manifest.yaml

@@ -0,0 +1,440 @@
+spec:
+  type: Spec
+  connection_specification:
+    $schema: http://json-schema.org/draft-07/schema#
+    title: Iterable Spec
+    type: object
+    required:
+      - start_date
+      - api_key
+    additionalProperties: true
+    properties:
+      api_key:
+        type: "string"
+        title: "API Key"
+        description: >-
+          Iterable API Key. See the <a href=\"https://docs.airbyte.com/integrations/sources/iterable\">docs</a> 
+          for more information on how to obtain this key.
+        airbyte_secret: true
+        order: 0
+      start_date:
+        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. 
+          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"
+type: DeclarativeSource
+check:
+  type: CheckStream
+  stream_names:
+    - lists
+streams:
+  - name: lists
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: lists
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - lists
+      partition_router: []
+    primary_key:
+      - id
+  - name: list_users
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: lists/getUsers
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          class_name: source_iterable.components.ListUsersRecordExtractor
+          field_path:
+            - getUsers
+      partition_router:
+        - type: SubstreamPartitionRouter
+          parent_stream_configs:
+            - type: ParentStreamConfig
+              parent_key: id
+              request_option:
+                inject_into: request_parameter
+                type: RequestOption
+                field_name: listId
+              partition_field: list_id
+              stream:
+                type: DeclarativeStream
+                name: lists
+                primary_key:
+                  - id
+                retriever:
+                  type: SimpleRetriever
+                  requester:
+                    type: HttpRequester
+                    url_base: https://api.iterable.com/api/
+                    path: lists
+                    http_method: GET
+                    request_parameters: {}
+                    request_headers: {}
+                    authenticator:
+                      type: ApiKeyAuthenticator
+                      api_token: "{{ config['api_key'] }}"
+                      inject_into:
+                        type: RequestOption
+                        field_name: Api-Key
+                        inject_into: header
+                    request_body_json: {}
+                  record_selector:
+                    type: RecordSelector
+                    extractor:
+                      type: DpathExtractor
+                      field_path:
+                        - lists
+                  paginator:
+                    type: NoPagination
+                  partition_router: []
+    primary_key:
+      - listId
+    transformations:
+      - type: AddFields
+        fields:
+          - path:
+              - listId
+            value: "{{ stream_slice.list_id }}"
+  - name: campaigns
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: campaigns
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - campaigns
+      partition_router: []
+    primary_key:
+      - id
+  - name: channels
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: channels
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - channels
+      partition_router: []
+    primary_key:
+      - id
+  - name: message_types
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: messageTypes
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - messageTypes
+      partition_router: []
+    primary_key:
+      - id
+  - name: metadata
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: metadata
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          type: DpathExtractor
+          field_path:
+            - results
+      partition_router: []
+    primary_key: []
+  - name: users
+    type: DeclarativeStream
+    retriever:
+      type: SimpleRetriever
+      paginator:
+        type: NoPagination
+      requester:
+        path: export/data.json
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        http_method: GET
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_headers: {}
+        request_body_json: {}
+        request_parameters:
+          stream: "True"
+          dataTypeName: user
+      record_selector:
+        type: RecordSelector
+        extractor:
+          class_name: source_iterable.components.XJsonRecordExtractor
+          field_path:
+            - users
+      partition_router: []
+    primary_key: []
+    incremental_sync:
+      step: P90D
+      type: DatetimeBasedCursor
+      cursor_field: profileUpdatedAt
+      end_datetime:
+        type: MinMaxDatetime
+        datetime: "{{ config['end_date'] if config['end_date'] else now_utc().strftime('%Y-%m-%dT%H:%M:%SZ') }}"
+        datetime_format: "%Y-%m-%dT%H:%M:%SZ"
+      start_datetime:
+        type: MinMaxDatetime
+        datetime: "{{ config['start_date'] }}"
+        datetime_format: "%Y-%m-%dT%H:%M:%SZ"
+      datetime_format: "%Y-%m-%d %H:%M:%S"
+      end_time_option:
+        type: RequestOption
+        field_name: endDateTime
+        inject_into: request_parameter
+      start_time_option:
+        type: RequestOption
+        field_name: startDateTime
+        inject_into: request_parameter
+      cursor_granularity: PT1S
+      cursor_datetime_formats:
+        - "%Y-%m-%d %H:%M:%S %z"
+        - "%Y-%m-%dT%H:%M:%S%z"
+  - name: events
+    primary_key: []
+    retriever:
+      type: SimpleRetriever
+      requester:
+        type: HttpRequester
+        url_base: https://api.iterable.com/api/
+        path: export/userEvents
+        http_method: GET
+        request_parameters:
+          includeCustomEvents: "true"
+        request_headers: {}
+        authenticator:
+          type: ApiKeyAuthenticator
+          api_token: "{{ config['api_key'] }}"
+          inject_into:
+            type: RequestOption
+            field_name: Api-Key
+            inject_into: header
+        request_body_json: {}
+      record_selector:
+        type: RecordSelector
+        extractor:
+          class_name: source_iterable.components.EventsRecordExtractor
+          field_path:
+            - events
+      paginator:
+        type: NoPagination
+      partition_router:
+        - type: SubstreamPartitionRouter
+          parent_stream_configs:
+            - type: ParentStreamConfig
+              parent_key: email
+              request_option:
+                inject_into: request_parameter
+                type: RequestOption
+                field_name: email
+              partition_field: email
+              stream:
+                name: list_users
+                type: DeclarativeStream
+                retriever:
+                  type: SimpleRetriever
+                  paginator:
+                    type: NoPagination
+                  requester:
+                    path: lists/getUsers
+                    type: HttpRequester
+                    url_base: https://api.iterable.com/api/
+                    http_method: GET
+                    authenticator:
+                      type: ApiKeyAuthenticator
+                      api_token: "{{ config['api_key'] }}"
+                      inject_into:
+                        type: RequestOption
+                        field_name: Api-Key
+                        inject_into: header
+                    request_headers: {}
+                    request_body_json: {}
+                    request_parameters: {}
+                  record_selector:
+                    type: RecordSelector
+                    extractor:
+                      class_name: source_iterable.components.ListUsersRecordExtractor
+                      field_path:
+                        - getUsers
+                  partition_router:
+                    - type: SubstreamPartitionRouter
+                      parent_stream_configs:
+                        - type: ParentStreamConfig
+                          parent_key: id
+                          request_option:
+                            inject_into: request_parameter
+                            type: RequestOption
+                            field_name: listId
+                          partition_field: list_id
+                          stream:
+                            type: DeclarativeStream
+                            name: lists
+                            primary_key:
+                              - id
+                            retriever:
+                              type: SimpleRetriever
+                              requester:
+                                type: HttpRequester
+                                url_base: https://api.iterable.com/api/
+                                path: lists
+                                http_method: GET
+                                request_parameters: {}
+                                request_headers: {}
+                                authenticator:
+                                  type: ApiKeyAuthenticator
+                                  api_token: "{{ config['api_key'] }}"
+                                  inject_into:
+                                    type: RequestOption
+                                    field_name: Api-Key
+                                    inject_into: header
+                                request_body_json: {}
+                              record_selector:
+                                type: RecordSelector
+                                extractor:
+                                  type: DpathExtractor
+                                  field_path:
+                                    - lists
+                              paginator:
+                                type: NoPagination
+                              partition_router: []
+                primary_key:
+                  - id
+                transformations:
+                  - type: AddFields
+                    fields:
+                      - path:
+                          - list_id
+                        value: "{{ stream_slice.list_id }}"
+version: 0.65.0
+metadata:
+  autoImportSchema:
+    users: false
+    lists: false
+    channels: false
+    metadata: false
+    campaigns: false
+    message_types: false

source_iterable/schemas/campaigns.json

@@ -1,60 +1,78 @@
 {
   "properties": {
     "id": {
+      "description": "The unique identifier of the campaign",
       "type": ["null", "integer"]
     },
     "createdAt": {
+      "description": "The timestamp when the campaign was created",
       "type": ["null", "integer"]
     },
     "updatedAt": {
+      "description": "The timestamp when the campaign was last updated",
       "type": ["null", "integer"]
     },
     "startAt": {
+      "description": "The timestamp when the campaign will start",
       "type": ["null", "integer"]
     },
     "endedAt": {
+      "description": "The timestamp when the campaign ended",
       "type": ["null", "integer"]
     },
     "name": {
+      "description": "The name of the campaign",
       "type": ["null", "string"]
     },
     "templateId": {
+      "description": "The ID of the template used for the campaign",
       "type": ["null", "integer"]
     },
     "messageMedium": {
+      "description": "The medium used to deliver the campaign message (e.g., email, SMS)",
       "type": ["null", "string"]
     },
     "createdByUserId": {
+      "description": "The ID of the user who created the campaign",
       "type": ["null", "string"]
     },
     "updatedByUserId": {
+      "description": "The ID of the user who last updated the campaign",
       "type": ["null", "string"]
     },
     "campaignState": {
+      "description": "The current state of the campaign (e.g., draft, active, paused)",
       "type": ["null", "string"]
     },
     "listIds": {
+      "description": "List of IDs of the lists targeted by the campaign",
       "type": ["null", "array"],
       "items": {}
     },
     "suppressionListIds": {
+      "description": "List of IDs of suppression lists for the campaign",
       "type": ["null", "array"],
       "items": {}
     },
     "sendSize": {
+      "description": "The size of the audience targeted by the campaign",
       "type": ["null", "number"]
     },
     "recurringCampaignId": {
+      "description": "If the campaign is recurring, the ID of the parent recurring campaign",
       "type": ["null", "number"]
     },
     "workflowId": {
+      "description": "The ID of the workflow associated with the campaign",
       "type": ["null", "number"]
     },
     "labels": {
+      "description": "List of labels associated with the campaign",
       "type": ["null", "array"],
       "items": {}
     },
     "type": {
+      "description": "The type of campaign (e.g., one-time, recurring)",
       "type": ["null", "string"]
     }
   },

source_iterable/schemas/campaigns_metrics.json

@@ -1,6 +1,7 @@
 {
   "properties": {
     "data": {
+      "description": "Contains the campaign metrics data",
       "type": ["null", "object"]
     }
   },

source_iterable/schemas/channels.json

@@ -1,15 +1,19 @@
 {
   "properties": {
     "id": {
+      "description": "The unique identifier of the channel.",
       "type": ["null", "number"]
     },
     "name": {
+      "description": "The name or title of the channel.",
       "type": ["null", "string"]
     },
     "channelType": {
+      "description": "The type of channel, such as email, SMS, or push notification.",
       "type": ["null", "string"]
     },
     "messageMedium": {
+      "description": "The medium used to deliver messages through this channel, such as text, image, or video.",
       "type": ["null", "string"]
     }
   },

source_iterable/schemas/email_bounce.json

@@ -1,38 +1,48 @@
 {
   "properties": {
     "createdAt": {
+      "description": "The date and time when the email bounce data was created.",
       "type": ["null", "string"],
       "format": "date-time"
     },
     "campaignId": {
+      "description": "The unique identifier of the campaign associated with the email bounce data.",
       "type": ["null", "integer"]
     },
     "itblInternal": {
+      "description": "Internal information related to Iterable.",
       "type": ["null", "object"],
       "properties": {
         "documentCreatedAt": {
+          "description": "The date and time when the internal document for Iterable was created.",
           "type": ["null", "string"],
           "format": "date-time"
         },
         "documentUpdatedAt": {
+          "description": "The date and time when the internal document for Iterable was last updated.",
           "type": ["null", "string"],
           "format": "date-time"
         }
       }
     },
     "messageId": {
+      "description": "The unique identifier of the message associated with the email bounce data.",
       "type": ["null", "string"]
     },
     "templateId": {
+      "description": "The unique identifier of the email template associated with the bounce data.",
       "type": ["null", "integer"]
     },
     "email": {
+      "description": "The email address that encountered a bounce.",
       "type": ["null", "string"]
     },
     "userId": {
+      "description": "The unique identifier of the user associated with the bounced email address.",
       "type": ["null", "string"]
     },
     "recipientState": {
+      "description": "The state of the recipient email address at the time of the bounce (e.g., active, inactive).",
       "type": ["null", "string"]
     }
   },