From 5e5a5e3a47b4fd8a93aad7f9c0e42d6841c83c03 Mon Sep 17 00:00:00 2001 From: Haithem SOUALA <75131226+haithem-souala@users.noreply.github.com> Date: Sat, 29 Oct 2022 00:14:51 +0200 Subject: [PATCH] :tada: New Source: Mailjet SMS (#18345) * init commit * add doc * add doc * change authentication methode * fix doc * fix doc * add docs * fix comments * use request_options_provider * lint * fix comments Co-authored-by: Marcos Marx --- .../source-mailjet-sms/.dockerignore | 6 ++ .../connectors/source-mailjet-sms/Dockerfile | 38 +++++++++ .../connectors/source-mailjet-sms/README.md | 79 +++++++++++++++++++ .../connectors/source-mailjet-sms/__init__.py | 3 + .../acceptance-test-config.yml | 28 +++++++ .../acceptance-test-docker.sh | 16 ++++ .../source-mailjet-sms/build.gradle | 9 +++ .../integration_tests/__init__.py | 3 + .../integration_tests/abnormal_state.json | 5 ++ .../integration_tests/acceptance.py | 16 ++++ .../integration_tests/configured_catalog.json | 13 +++ .../integration_tests/invalid_config.json | 5 ++ .../integration_tests/sample_config.json | 5 ++ .../integration_tests/sample_state.json | 5 ++ .../connectors/source-mailjet-sms/main.py | 13 +++ .../source-mailjet-sms/requirements.txt | 2 + .../connectors/source-mailjet-sms/setup.py | 29 +++++++ .../source_mailjet_sms/__init__.py | 8 ++ .../source_mailjet_sms/mailjet_sms.yaml | 59 ++++++++++++++ .../source_mailjet_sms/schemas/sms.json | 46 +++++++++++ .../source_mailjet_sms/source.py | 18 +++++ .../source_mailjet_sms/spec.yaml | 30 +++++++ docs/integrations/README.md | 2 +- docs/integrations/sources/mailjet-sms.md | 32 ++++++++ 24 files changed, 469 insertions(+), 1 deletion(-) create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/.dockerignore create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/Dockerfile create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/README.md create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/__init__.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-config.yml create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-docker.sh create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/build.gradle create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/__init__.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/abnormal_state.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/acceptance.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/configured_catalog.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/invalid_config.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_config.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_state.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/main.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/requirements.txt create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/setup.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/__init__.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/mailjet_sms.yaml create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/schemas/sms.json create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/source.py create mode 100644 airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/spec.yaml create mode 100644 docs/integrations/sources/mailjet-sms.md diff --git a/airbyte-integrations/connectors/source-mailjet-sms/.dockerignore b/airbyte-integrations/connectors/source-mailjet-sms/.dockerignore new file mode 100644 index 000000000000..d78ee20e73f8 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/.dockerignore @@ -0,0 +1,6 @@ +* +!Dockerfile +!main.py +!source_mailjet_sms +!setup.py +!secrets diff --git a/airbyte-integrations/connectors/source-mailjet-sms/Dockerfile b/airbyte-integrations/connectors/source-mailjet-sms/Dockerfile new file mode 100644 index 000000000000..3edf019983f5 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/Dockerfile @@ -0,0 +1,38 @@ +FROM python:3.9.11-alpine3.15 as base + +# build and load all requirements +FROM base as builder +WORKDIR /airbyte/integration_code + +# upgrade pip to the latest version +RUN apk --no-cache upgrade \ + && pip install --upgrade pip \ + && apk --no-cache add tzdata build-base + + +COPY setup.py ./ +# install necessary packages to a temporary folder +RUN pip install --prefix=/install . + +# build a clean environment +FROM base +WORKDIR /airbyte/integration_code + +# copy all loaded and built libraries to a pure basic image +COPY --from=builder /install /usr/local +# add default timezone settings +COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime +RUN echo "Etc/UTC" > /etc/timezone + +# bash is installed for more convenient debugging. +RUN apk --no-cache add bash + +# copy payload code only +COPY main.py ./ +COPY source_mailjet_sms ./source_mailjet_sms + +ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py" +ENTRYPOINT ["python", "/airbyte/integration_code/main.py"] + +LABEL io.airbyte.version=0.1.0 +LABEL io.airbyte.name=airbyte/source-mailjet-sms diff --git a/airbyte-integrations/connectors/source-mailjet-sms/README.md b/airbyte-integrations/connectors/source-mailjet-sms/README.md new file mode 100644 index 000000000000..c93c50623f14 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/README.md @@ -0,0 +1,79 @@ +# Mailjet Sms Source + +This is the repository for the Mailjet Sms configuration based source connector. +For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/mailjet-sms). + +## Local development + +#### Building via Gradle +You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow. + +To build using Gradle, from the Airbyte repository root, run: +``` +./gradlew :airbyte-integrations:connectors:source-mailjet-sms:build +``` + +#### Create credentials +**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/mailjet-sms) +to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mailjet_sms/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 `integration_tests/sample_config.json` for a sample config file. + +**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source mailjet-sms test creds` +and place them into `secrets/config.json`. + +### Locally running the connector docker image + +#### Build +First, make sure you build the latest Docker image: +``` +docker build . -t airbyte/source-mailjet-sms:dev +``` + +You can also build the connector image via Gradle: +``` +./gradlew :airbyte-integrations:connectors:source-mailjet-sms:airbyteDocker +``` +When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in +the Dockerfile. + +#### Run +Then run any of the connector commands as follows: +``` +docker run --rm airbyte/source-mailjet-sms:dev spec +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mailjet-sms:dev check --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-mailjet-sms:dev discover --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-mailjet-sms:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json +``` +## Testing + +#### Acceptance Tests +Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-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. + +To run your integration tests with docker + +### Using gradle to run tests +All commands should be run from airbyte project root. +To run unit tests: +``` +./gradlew :airbyte-integrations:connectors:source-mailjet-sms:unitTest +``` +To run acceptance and custom integration tests: +``` +./gradlew :airbyte-integrations:connectors:source-mailjet-sms:integrationTest +``` + +## Dependency Management +All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development. +We split dependencies between two groups, dependencies that are: +* required for your connector to work need to go to `MAIN_REQUIREMENTS` list. +* required for the testing need to go to `TEST_REQUIREMENTS` list + +### 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 unit and integration tests. +1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). +1. Create a Pull Request. +1. Pat yourself on the back for being an awesome contributor. +1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. diff --git a/airbyte-integrations/connectors/source-mailjet-sms/__init__.py b/airbyte-integrations/connectors/source-mailjet-sms/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-config.yml b/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-config.yml new file mode 100644 index 000000000000..1df67e61fb0c --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-config.yml @@ -0,0 +1,28 @@ +# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference) +# for more information about how to configure these tests +connector_image: airbyte/source-mailjet-sms:dev +tests: + spec: + - spec_path: "source_mailjet_sms/spec.yaml" + connection: + - config_path: "secrets/config.json" + status: "succeed" + - config_path: "integration_tests/invalid_config.json" + status: "failed" + discovery: + - config_path: "secrets/config.json" + basic_read: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" + empty_streams: ["sms"] + timeout_seconds: 30 + # TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file + # expect_records: + # path: "integration_tests/expected_records.txt" + # extra_fields: no + # exact_order: no + # extra_records: yes + full_refresh: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" + timeout_seconds: 30 diff --git a/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-docker.sh new file mode 100644 index 000000000000..c51577d10690 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/acceptance-test-docker.sh @@ -0,0 +1,16 @@ +#!/usr/bin/env sh + +# Build latest connector image +docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-) + +# Pull latest acctest image +docker pull airbyte/source-acceptance-test:latest + +# Run +docker run --rm -it \ + -v /var/run/docker.sock:/var/run/docker.sock \ + -v /tmp:/tmp \ + -v $(pwd):/test_input \ + airbyte/source-acceptance-test \ + --acceptance-test-config /test_input + diff --git a/airbyte-integrations/connectors/source-mailjet-sms/build.gradle b/airbyte-integrations/connectors/source-mailjet-sms/build.gradle new file mode 100644 index 000000000000..6ec77e0faeec --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/build.gradle @@ -0,0 +1,9 @@ +plugins { + id 'airbyte-python' + id 'airbyte-docker' + id 'airbyte-source-acceptance-test' +} + +airbytePython { + moduleDirectory 'source_mailjet_sms' +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/__init__.py b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/abnormal_state.json b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/abnormal_state.json new file mode 100644 index 000000000000..52b0f2c2118f --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/abnormal_state.json @@ -0,0 +1,5 @@ +{ + "todo-stream-name": { + "todo-field-name": "todo-abnormal-value" + } +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/acceptance.py new file mode 100644 index 000000000000..1302b2f57e10 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/acceptance.py @@ -0,0 +1,16 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +import pytest + +pytest_plugins = ("source_acceptance_test.plugin",) + + +@pytest.fixture(scope="session", autouse=True) +def connector_setup(): + """This fixture is a placeholder for external resources that acceptance test might require.""" + # TODO: setup test dependencies if needed. otherwise remove the TODO comments + yield + # TODO: clean up test dependencies diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/configured_catalog.json new file mode 100644 index 000000000000..8d2564fa27de --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/configured_catalog.json @@ -0,0 +1,13 @@ +{ + "streams": [ + { + "stream": { + "name": "sms", + "json_schema": {}, + "supported_sync_modes": ["full_refresh"] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + } + ] +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/invalid_config.json new file mode 100644 index 000000000000..87fa3ed48875 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/invalid_config.json @@ -0,0 +1,5 @@ +{ + "token": "xxxxxxxxxxx", + "start_date": 1666262531, + "end_date": 1666953731 +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_config.json new file mode 100644 index 000000000000..ed1748cb1b13 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_config.json @@ -0,0 +1,5 @@ +{ + "token": "d36cb74ebe137152e09e4e5ca08d1cfd", + "start_date": 1666262531, + "end_date": 1666953731 +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_state.json b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_state.json new file mode 100644 index 000000000000..3587e579822d --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/integration_tests/sample_state.json @@ -0,0 +1,5 @@ +{ + "todo-stream-name": { + "todo-field-name": "value" + } +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/main.py b/airbyte-integrations/connectors/source-mailjet-sms/main.py new file mode 100644 index 000000000000..d3cad995e0da --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/main.py @@ -0,0 +1,13 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +import sys + +from airbyte_cdk.entrypoint import launch +from source_mailjet_sms import SourceMailjetSms + +if __name__ == "__main__": + source = SourceMailjetSms() + launch(source, sys.argv[1:]) diff --git a/airbyte-integrations/connectors/source-mailjet-sms/requirements.txt b/airbyte-integrations/connectors/source-mailjet-sms/requirements.txt new file mode 100644 index 000000000000..0411042aa091 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/requirements.txt @@ -0,0 +1,2 @@ +-e ../../bases/source-acceptance-test +-e . diff --git a/airbyte-integrations/connectors/source-mailjet-sms/setup.py b/airbyte-integrations/connectors/source-mailjet-sms/setup.py new file mode 100644 index 000000000000..1fbf89120862 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/setup.py @@ -0,0 +1,29 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from setuptools import find_packages, setup + +MAIN_REQUIREMENTS = [ + "airbyte-cdk~=0.1", +] + +TEST_REQUIREMENTS = [ + "pytest~=6.1", + "pytest-mock~=3.6.1", + "source-acceptance-test", +] + +setup( + name="source_mailjet_sms", + description="Source implementation for Mailjet Sms.", + author="Airbyte", + author_email="contact@airbyte.io", + packages=find_packages(), + install_requires=MAIN_REQUIREMENTS, + package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]}, + extras_require={ + "tests": TEST_REQUIREMENTS, + }, +) diff --git a/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/__init__.py b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/__init__.py new file mode 100644 index 000000000000..a8199863bdbd --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/__init__.py @@ -0,0 +1,8 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from .source import SourceMailjetSms + +__all__ = ["SourceMailjetSms"] diff --git a/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/mailjet_sms.yaml b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/mailjet_sms.yaml new file mode 100644 index 000000000000..b237cbda54a4 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/mailjet_sms.yaml @@ -0,0 +1,59 @@ +version: "0.1.0" + +definitions: + selector: + extractor: + field_pointer: ["Data"] + requester: + url_base: "https://api.mailjet.com/v4" + http_method: "GET" + request_options_provider: + request_parameters: + fromTS: "{{ config['start_date'] }}" + ToTS: "{{ config['end_date'] }}" + authenticator: + type: BearerAuthenticator + api_token: "{{ config['token'] }}" + offset_paginator: + type: DefaultPaginator + $options: + url_base: "*ref(definitions.requester.url_base)" + pagination_strategy: + type: "OffsetIncrement" + page_size: 100 + page_token_option: + field_name: "Offset" + inject_into: "request_parameter" + page_size_option: + inject_into: "request_parameter" + field_name: "Limit" + retriever: + record_selector: + $ref: "*ref(definitions.selector)" + paginator: + type: NoPagination + requester: + $ref: "*ref(definitions.requester)" + base_stream: + retriever: + $ref: "*ref(definitions.retriever)" + sms_stream: + $ref: "*ref(definitions.base_stream)" + retriever: + record_selector: + $ref: "*ref(definitions.selector)" + paginator: + $ref: "*ref(definitions.offset_paginator)" + requester: + $ref: "*ref(definitions.requester)" + $options: + name: "sms" + primary_key: "ID" + path: "/sms" + +streams: + - "*ref(definitions.sms_stream)" + +check: + stream_names: + - "sms" diff --git a/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/schemas/sms.json b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/schemas/sms.json new file mode 100644 index 000000000000..055e2b553a56 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/schemas/sms.json @@ -0,0 +1,46 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema#", + "type": "object", + "properties": { + "ID": { + "type": "string" + }, + "From": { + "type": "string" + }, + "To": { + "type": "string" + }, + "Status": { + "type": "object", + "properties": { + "Code": { + "type": "number" + }, + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + } + } + }, + "Cost": { + "type": "object", + "properties": { + "Value": { + "type": "number" + }, + "Currency": { + "type": "string" + } + } + }, + "CreationTS": { + "type": "integer" + }, + "SmsCount": { + "type": "integer" + } + } +} diff --git a/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/source.py b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/source.py new file mode 100644 index 000000000000..c34b4bc06ba3 --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/source.py @@ -0,0 +1,18 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + +from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource + +""" +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 SourceMailjetSms(YamlDeclarativeSource): + def __init__(self): + super().__init__(**{"path_to_yaml": "mailjet_sms.yaml"}) diff --git a/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/spec.yaml b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/spec.yaml new file mode 100644 index 000000000000..14d4d60f5edf --- /dev/null +++ b/airbyte-integrations/connectors/source-mailjet-sms/source_mailjet_sms/spec.yaml @@ -0,0 +1,30 @@ +documentationUrl: https://docs.airbyte.com/integrations/sources/mailjet-sms +connectionSpecification: + $schema: http://json-schema.org/draft-07/schema# + title: Mailjet Sms Spec + type: object + required: + - token + additionalProperties: true + properties: + token: + title: Access Token + type: string + description: >- + Your access token. See here. + airbyte_secret: true + start_date: + title: Start date + type: integer + description: Retrieve SMS messages created after the specified timestamp. Required format - Unix timestamp. + pattern: ^[0-9]*$ + examples: + - 1666261656 + end_date: + title: End date + type: integer + description: Retrieve SMS messages created before the specified timestamp. Required format - Unix timestamp. + pattern: ^[0-9]*$ + examples: + - 1666281656 diff --git a/docs/integrations/README.md b/docs/integrations/README.md index 91cb1d75cb6b..43cea740048a 100644 --- a/docs/integrations/README.md +++ b/docs/integrations/README.md @@ -104,9 +104,9 @@ For more information about the grading system, see [Product Release Stages](http | [Looker](sources/looker.md) | Alpha | Yes | | [Magento](sources/magento.md) | Alpha | No | | [Mailchimp](sources/mailchimp.md) | Generally Available | Yes | +| [Mailjet SMS](sources/mailjet-sms.md) | Alpha | No | | [Mailjet Mail](sources/mailjet-mail.md) | Alpha | No | | [Mailerlite](sources/mailerlite.md) | Alpha | No | -| [Mailjet Mail](sources/mailjet-mail.md) | Alpha | No | | [Marketo](sources/marketo.md) | Generally Available | Yes | | [Metabase](sources/metabase.md) | Alpha | Yes | | [Microsoft Dynamics AX](sources/microsoft-dynamics-ax.md) | Alpha | No | diff --git a/docs/integrations/sources/mailjet-sms.md b/docs/integrations/sources/mailjet-sms.md new file mode 100644 index 000000000000..35dc257a548c --- /dev/null +++ b/docs/integrations/sources/mailjet-sms.md @@ -0,0 +1,32 @@ +# Mailjet - SMS API + +## Sync overview + +This source can sync data from the [Mailjet SMS API](https://dev.mailjet.com/sms). At present this connector only supports full refresh syncs meaning that each time you use the connector it will sync all available records from scratch. Please use cautiously if you expect your API to have a lot of records. + +## This Source Supports the Following Streams + +* SMS + +### Features + +| Feature | Supported?\(Yes/No\) | Notes | +| :--- | :--- | :--- | +| Full Refresh Sync | Yes | | +| Incremental Sync | No | | + +### Performance considerations + +Mailjet APIs are under rate limits for the number of API calls allowed per API keys per second. If you reach a rate limit, API will return a 429 HTTP error code. See [here](https://dev.mailjet.com/sms/reference/overview/rate-limits/) + +## Getting started + +### Requirements + +* Mailjet SMS TOKEN + +## Changelog + +| Version | Date | Pull Request | Subject | +| :------ | :--------- | :-------------------------------------------------------- | :----------------------------------------- | +| 0.1.0 | 2022-10-26 | [#18345](https://github.com/airbytehq/airbyte/pull/18345) | 🎉 New Source: Mailjet SMS API [low-code CDK] | \ No newline at end of file