airbyte-source-iterable 0.5.0__tar.gz → 0.5.1.dev202405100053__tar.gz

{airbyte_source_iterable-0.5.0 → airbyte_source_iterable-0.5.1.dev202405100053}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-source-iterable
-Version: 0.5.0
+Version: 0.5.1.dev202405100053
 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.88.1)
 Requires-Dist: pendulum (==2.1.2)
 Requires-Dist: python-dateutil (==2.8.2)
 Requires-Dist: requests (==2.31.0)
@@ -22,32 +22,33 @@ 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)
 
+- 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
@@ -56,23 +57,28 @@ poetry run source-iterable read --config secrets/config.json --catalog sample_fi
 ```
 
 ### 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
@@ -81,18 +87,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### 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. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -100,14 +111,17 @@ 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`
+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.5.0 → airbyte_source_iterable-0.5.1.dev202405100053}/README.md

@@ -1,31 +1,32 @@
 # 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)
 
+- 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
@@ -34,23 +35,28 @@ poetry run source-iterable read --config secrets/config.json --catalog sample_fi
 ```
 
 ### 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
@@ -59,18 +65,23 @@ docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integrat
 ```
 
 ### 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. 
+
+All of your dependencies should be managed via Poetry.
 To add a new dependency, run:
+
 ```bash
 poetry add <package-name>
 ```
@@ -78,14 +89,16 @@ 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`
+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.
+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.5.0 → airbyte_source_iterable-0.5.1.dev202405100053}/pyproject.toml

@@ -5,7 +5,7 @@ requires = [
 build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
-version = "0.5.0"
+version = "0.5.1.dev202405100053"
 name = "airbyte-source-iterable"
 description = "Source implementation for Iterable."
 authors = [
@@ -23,7 +23,7 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.9,<3.12"
 pendulum = "==2.1.2"
-airbyte-cdk = "^0"
+airbyte-cdk = "0.88.1"
 requests = "==2.31.0"
 python-dateutil = "==2.8.2"
 

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/campaigns.json

@@ -0,0 +1,80 @@
+{
+  "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"]
+    }
+  },
+  "type": ["null", "object"]
+}

{airbyte_source_iterable-0.5.0 → airbyte_source_iterable-0.5.1.dev202405100053}/source_iterable/schemas/campaigns_metrics.json

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

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/channels.json

@@ -0,0 +1,21 @@
+{
+  "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"]
+    }
+  },
+  "type": ["null", "object"]
+}

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/email_bounce.json

@@ -0,0 +1,50 @@
+{
+  "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"]
+    }
+  },
+  "type": ["null", "object"]
+}

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/email_click.json

@@ -0,0 +1,82 @@
+{
+  "properties": {
+    "country": {
+      "description": "The country from where the email click was recorded.",
+      "type": ["null", "string"]
+    },
+    "city": {
+      "description": "The city from where the email click was recorded.",
+      "type": ["null", "string"]
+    },
+    "campaignId": {
+      "description": "The unique identifier of the campaign associated with the email click data.",
+      "type": ["null", "integer"]
+    },
+    "itblInternal": {
+      "description": "Internal data related to the iterable service.",
+      "type": ["null", "object"],
+      "properties": {
+        "documentCreatedAt": {
+          "description": "The date and time when the internal document was created.",
+          "type": ["null", "string"],
+          "format": "date-time"
+        },
+        "documentUpdatedAt": {
+          "description": "The date and time when the internal document was last updated.",
+          "type": ["null", "string"],
+          "format": "date-time"
+        }
+      }
+    },
+    "ip": {
+      "description": "The IP address from where the email click was recorded.",
+      "type": ["null", "string"]
+    },
+    "contentId": {
+      "description": "The identifier of the content clicked within the email.",
+      "type": ["null", "integer"]
+    },
+    "userAgentDevice": {
+      "description": "The device information of the user agent used for the email click.",
+      "type": ["null", "string"]
+    },
+    "messageId": {
+      "description": "The unique identifier of the message that contained the email.",
+      "type": ["null", "string"]
+    },
+    "hrefIndex": {
+      "description": "The index of the href link within the email content.",
+      "type": ["null", "integer"]
+    },
+    "userAgent": {
+      "description": "The user agent of the browser or application used for the email click.",
+      "type": ["null", "string"]
+    },
+    "templateId": {
+      "description": "The identifier of the email template used in the campaign.",
+      "type": ["null", "integer"]
+    },
+    "url": {
+      "description": "The URL that was clicked within the email.",
+      "type": ["null", "string"]
+    },
+    "createdAt": {
+      "description": "The date and time when the email click event occurred.",
+      "type": ["null", "string"],
+      "format": "date-time"
+    },
+    "region": {
+      "description": "The region from where the email click was recorded.",
+      "type": ["null", "string"]
+    },
+    "email": {
+      "description": "The email address of the user who clicked the email link.",
+      "type": ["null", "string"]
+    },
+    "userId": {
+      "description": "The unique identifier of the user who clicked the email link.",
+      "type": ["null", "string"]
+    }
+  },
+  "type": ["null", "object"]
+}

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/email_complaint.json

@@ -0,0 +1,50 @@
+{
+  "properties": {
+    "createdAt": {
+      "description": "Timestamp indicating when the email complaint was created",
+      "type": ["null", "string"],
+      "format": "date-time"
+    },
+    "campaignId": {
+      "description": "Unique identifier for the campaign associated with the email complaint data",
+      "type": ["null", "integer"]
+    },
+    "itblInternal": {
+      "description": "Holds internal metadata related to the iterable data being accessed.",
+      "type": ["null", "object"],
+      "properties": {
+        "documentCreatedAt": {
+          "description": "Timestamp indicating when the internal document was created",
+          "type": ["null", "string"],
+          "format": "date-time"
+        },
+        "documentUpdatedAt": {
+          "description": "Timestamp indicating when the internal document was last updated",
+          "type": ["null", "string"],
+          "format": "date-time"
+        }
+      }
+    },
+    "messageId": {
+      "description": "Unique identifier for the email message associated with the complaint",
+      "type": ["null", "string"]
+    },
+    "templateId": {
+      "description": "Unique identifier for the email template used in the campaign",
+      "type": ["null", "integer"]
+    },
+    "email": {
+      "description": "Email address of the recipient who lodged the complaint",
+      "type": ["null", "string"]
+    },
+    "userId": {
+      "description": "Unique identifier for the user who lodged the email complaint",
+      "type": ["null", "string"]
+    },
+    "recipientState": {
+      "description": "State or status of the recipient associated with the complaint",
+      "type": ["null", "string"]
+    }
+  },
+  "type": ["null", "object"]
+}

airbyte_source_iterable-0.5.1.dev202405100053/source_iterable/schemas/email_open.json

@@ -0,0 +1,70 @@
+{
+  "properties": {
+    "country": {
+      "description": "The country from which the email was opened.",
+      "type": ["null", "string"]
+    },
+    "createdAt": {
+      "description": "The timestamp when the email_open event occurred.",
+      "type": ["null", "string"],
+      "format": "date-time"
+    },
+    "city": {
+      "description": "The city from which the email was opened.",
+      "type": ["null", "string"]
+    },
+    "campaignId": {
+      "description": "The unique identifier of the campaign to which the email_open event belongs.",
+      "type": ["null", "integer"]
+    },
+    "itblInternal": {
+      "description": "Internal data related to the email open event.",
+      "type": ["null", "object"],
+      "properties": {
+        "documentCreatedAt": {
+          "description": "The timestamp when the ITBL internal document was created.",
+          "type": ["null", "string"],
+          "format": "date-time"
+        },
+        "documentUpdatedAt": {
+          "description": "The timestamp when the ITBL internal document was last updated.",
+          "type": ["null", "string"],
+          "format": "date-time"
+        }
+      }
+    },
+    "ip": {
+      "description": "The IP address from which the email was opened.",
+      "type": ["null", "string"]
+    },
+    "userAgentDevice": {
+      "description": "The device information from which the email was opened.",
+      "type": ["null", "string"]
+    },
+    "messageId": {
+      "description": "The unique identifier of the email message.",
+      "type": ["null", "string"]
+    },
+    "userAgent": {
+      "description": "The user agent string of the browser used to open the email.",
+      "type": ["null", "string"]
+    },
+    "templateId": {
+      "description": "The unique identifier of the email template used.",
+      "type": ["null", "integer"]
+    },
+    "region": {
+      "description": "The region from which the email was opened.",
+      "type": ["null", "string"]
+    },
+    "email": {
+      "description": "The email address of the user who opened the email.",
+      "type": ["null", "string"]
+    },
+    "userId": {
+      "description": "The unique identifier of the user who opened the email.",
+      "type": ["null", "string"]
+    }
+  },
+  "type": ["null", "object"]
+}