airbyte icon indicating copy to clipboard operation
airbyte copied to clipboard

✨ Source Klaviyo: Add `Campaign Messages` `Flow Actions` `Flow Messages` streams

Open airt opened this issue 1 year ago • 10 comments

What

  • Add Campaign Messages Flow Actions Flow Messages streams to source klaviyo

How

  • Introduce a base class KlaviyoSubStream for working with the nested Klaviyo API which has a parent entity, using the HttpSubStream
  • Introduce Campaign Messages Flow Actions Flow Messages streams based on KlaviyoSubStream

Recommended reading order

  1. airbyte-integrations/connectors/source-klaviyo/source_klaviyo/streams.py
  2. airbyte-integrations/connectors/source-klaviyo/source_klaviyo/source.py
  3. airbyte-integrations/connectors/source-klaviyo/unit_tests/test_streams.py

User Impact

  • Add Campaign Messages Flow Actions Flow Messages streams
  • No breaking changes

Pre-merge Actions

Expand the relevant checklist and delete the others.

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Unit & integration tests added

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • If new credentials are required for use in CI, add them to GSM. Instructions.

airt avatar Feb 06 '24 11:02 airt

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Feb 06 '24 11:02 CLAassistant

Before Merging a Connector Pull Request

Wow! What a great pull request you have here! 🎉

To merge this PR, ensure the following has been done/considered for each connector added or updated:

  • [ ] PR name follows PR naming conventions
  • [ ] Breaking changes are considered. If a Breaking Change is being introduced, ensure an Airbyte engineer has created a Breaking Change Plan.
  • [ ] Connector version has been incremented in the Dockerfile and metadata.yaml according to our Semantic Versioning for Connectors guidelines
  • [ ] You've updated the connector's metadata.yaml file any other relevant changes, including a breakingChanges entry for major version bumps. See metadata.yaml docs
  • [ ] Secrets in the connector's spec are annotated with airbyte_secret
  • [ ] All documentation files are up to date. (README.md, bootstrap.md, docs.md, etc...)
  • [ ] Changelog updated in docs/integrations/<source or destination>/<name>.md with an entry for the new version. See changelog example
  • [ ] Migration guide updated in docs/integrations/<source or destination>/<name>-migrations.md with an entry for the new version, if the version is a breaking change. See migration guide example
  • [ ] If set, you've ensured the icon is present in the platform-internal repo. (Docs)

If the checklist is complete, but the CI check is failing,

  1. Check for hidden checklists in your PR description

  2. Toggle the github label checklist-action-run on/off to re-run the checklist CI.

github-actions[bot] avatar Feb 06 '24 11:02 github-actions[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 24, 2024 6:58am

vercel[bot] avatar Feb 06 '24 11:02 vercel[bot]

Hello @airt thanks for contribution. I took a quick look and the implementation looks good. Now the connector team need to do the final review to measure impact and how to release the change. I ask you patience during the review process sometimes it can be quite difficult for certified connectors (the team need to ensure the change won't break existing connections or introduces bugs). Before start the review, are you able to resolve the existing conflicts?

marcosmarxm avatar Feb 16 '24 20:02 marcosmarxm

Hello @airt thanks for contribution. I took a quick look and the implementation looks good. Now the connector team need to do the final review to measure impact and how to release the change. I ask you patience during the review process sometimes it can be quite difficult for certified connectors (the team need to ensure the change won't break existing connections or introduces bugs). Before start the review, are you able to resolve the existing conflicts?

@marcosmarxm conflicts resolved

airt avatar Feb 18 '24 06:02 airt

@askarpets @lazebnyi can you take a look in this pull request please

marcosmarxm avatar Mar 28 '24 15:03 marcosmarxm

@marcosmarxm this connector is currently being migrated to low-code. Can we wait until the migration is merged and after that add these new streams please?

askarpets avatar Apr 04 '24 07:04 askarpets

@askarpets sure! I'll let this in the backlog for now.

marcosmarxm avatar Apr 10 '24 16:04 marcosmarxm

Hello @airt, could you please resolve conflicts in this PR?

askarpets avatar May 17 '24 13:05 askarpets

Hello @airt, could you please resolve conflicts in this PR?

done

airt avatar May 24 '24 03:05 airt

So Campaign Messages and Flow Messages are already available?

marionettists avatar Aug 19 '24 14:08 marionettists