OpenFn / OpenFn/adaptors

`mailchimp` improvements

Open
#348 0 comments 0 reactions 1 assignee View on GitHub

@mtuchi is already working on this.

Since Aug 17, 2023.

  • #350 by @mtuchi — closed without merging
documentation enhancement
Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

In Summary

Most of the function available in mailchimp adaptor does not have a documentation that correspond to a Mailchimp API endpoints. which make it hard to understand which adaptor function to use.

Request in simple words as possible
  • Add description in each mailchimp function, that correspond with Mailchimp API endpoint that is used behind that function
  • Document the supported options for each function
  • Add examples of how to use the function if possible
  • Update function names so that they clearly describe the operation (i.e., we know the existing function updateMember() needs to be changed to -> upsertMember() because it both creates and updates members)
  • update upsertMembers to use members as option not users

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.