superfaceai / station

Comlink metadata for self-integrating applications.
https://superface.ai/catalog
MIT License
22 stars 5 forks source link

chore: Rename mailchimp to mandrillapp #262

Closed jnv closed 2 years ago

jnv commented 2 years ago

Description

Fixes #248.

This renames mailchimp provider to mandrillapp and changes both related maps (communication/send-email and communication/send-templated-email) to use mandrillapp instead.

I kept mailchimp app unchanged for the time being, it will have to be eventually changed to be able to target Mailchimp's API.

Motivation and Context

This is usability enhancment, as we have found that current identification of "mailchimp" provider is confusing for users, because transactional emails are actually sent with "mandrillapp". This caused users to use Mailchimp's API keys and ending up with "Invalid key" errors.

Types of changes

Checklist:

freaz commented 2 years ago

I kept mailchimp app unchanged for the time being, it will have to be eventually changed to be able to target Mailchimp's API.

Can you elaborate what app do you mean?

jnv commented 2 years ago

I kept mailchimp app unchanged for the time being, it will have to be eventually changed to be able to target Mailchimp's API.

Can you elaborate what app do you mean?

Mailchimp provides marketing API at https://*.api.mailchimp.com; should we support that with other use cases in the future, we will have to modify the mailchimp provider definition.

The change itself looks fine. But I am wondering if you have a plan what will happen with mailchimp provider and maps already published to registry.

It would be great if there were a possibility to hide the mailchimp provider on the relevant profiles' pages without removing the maps altogether, but I understand if it's not an option now. I assume the mailchimp maps will "disappear" with new minor versions of relevant profiles. I will also post an announcement on Discord and update our Resilient email tutorial.

freaz commented 2 years ago

Oh ok, I got it now. We will need to add another service to support marketing APIs. 👍