@openfn/language-mailchimp 0.7.0 → 0.7.1

package/configuration-schema.json

@@ -2,24 +2,26 @@
     "$schema": "http://json-schema.org/draft-07/schema#",
     "properties": {
         "server": {
-            "title": "Server URL",
+            "title": "Data Center",
             "type": "string",
-            "description": "Mailchimp API domain URL",
-            "format": "uri",
-            "minLength": 1,
+            "description": "Mailchimp Data Center for your account",
+            "minLength": 3,
             "examples": [
-                "https://mailchimp.com/api"
-            ]
+                "us11",
+                "uk8",
+                "in10"
+            ],
+            "pattern": "^[a-zA-Z]{2}\\d{1,2}$"
         },
         "apiKey": {
             "title": "API Key",
             "type": "string",
             "description": "Mailchimp API Key",
-            "writeOnly": true,
-            "minLength": 1,
+            "minLength": 32,
             "examples": [
-                "somEThINGkeyish"
-            ]
+                "0eb22c7b4a1c5bcd789379bf8a92902d-us13"
+            ],
+            "pattern": "^[a-zA-Z0-9]{20}-[a-zA-Z]{2}\\d{1,2}$"
         }
     },
     "type": "object",

package/dist/index.cjs

@@ -265,7 +265,7 @@ var assertOK = (response, fullUrl) => {
     throw error;
   }
 };
-var request = (method, path, options, callback) => {
+function request(method, path, options, callback) {
   return async (state) => {
     const apiVersion = "3.0";
     const { apiKey, server } = state.configuration;
@@ -291,6 +291,7 @@ var request = (method, path, options, callback) => {
       query,
       body: body ? JSON.stringify(body) : void 0
     });
+    console.log("Mailchimp says", response.statusCode);
     const responseBody = await response.body.json();
     assertOK(responseBody, `https://${server}.api.mailchimp.com${urlPath}`);
     const nextState = {
@@ -302,9 +303,13 @@ var request = (method, path, options, callback) => {
       return callback(nextState);
     return nextState;
   };
-};
-var get = (path, query, callback) => request("GET", path, { query }, callback);
-var post = (path, body, query, callback) => request("POST", path, { body, query }, callback);
+}
+function get(path, query, callback) {
+  return request("GET", path, { query }, callback);
+}
+function post(path, body, query, callback) {
+  return request("POST", path, { body, query }, callback);
+}
 
 // src/index.js
 var src_default = Adaptor_exports;

package/dist/index.js

@@ -223,7 +223,7 @@ var assertOK = (response, fullUrl) => {
     throw error;
   }
 };
-var request = (method, path, options, callback) => {
+function request(method, path, options, callback) {
   return async (state) => {
     const apiVersion = "3.0";
     const { apiKey, server } = state.configuration;
@@ -249,6 +249,7 @@ var request = (method, path, options, callback) => {
       query,
       body: body ? JSON.stringify(body) : void 0
     });
+    console.log("Mailchimp says", response.statusCode);
     const responseBody = await response.body.json();
     assertOK(responseBody, `https://${server}.api.mailchimp.com${urlPath}`);
     const nextState = {
@@ -260,9 +261,13 @@ var request = (method, path, options, callback) => {
       return callback(nextState);
     return nextState;
   };
-};
-var get = (path, query, callback) => request("GET", path, { query }, callback);
-var post = (path, body, query, callback) => request("POST", path, { body, query }, callback);
+}
+function get(path, query, callback) {
+  return request("GET", path, { query }, callback);
+}
+function post(path, body, query, callback) {
+  return request("POST", path, { body, query }, callback);
+}
 
 // src/index.js
 var src_default = Adaptor_exports;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-mailchimp",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "An OpenFn adaptor for use with Mailchimp",
   "main": "dist/index.cjs",
   "author": "Open Function Group",

package/types/Adaptor.d.ts

@@ -133,8 +133,43 @@ export function listAudiences(query: object, callback?: Function): Operation;
  * @returns {Operation}
  */
 export function listAudienceInfo(query: object, callback?: Function): Operation;
+/**
+ * Make an HTTP request to Mailchimp API
+ * @example <caption>Get list to all other resources available in the API</caption>
+ * request('GET','/');
+ * @example <caption>Create a new account export in your Mailchimp account</caption>
+ * request('POST','/accounts-export', {include_stages:[]});
+ * @function
+ * @param {string} method - The HTTP method for the request (e.g., 'GET', 'POST', 'PUT', 'DELETE').
+ * @param {string} path - The endpoint of the api to which the request should be made.
+ * @param {Object} options - Additional options for the request (query, body only).
+ * @param {function} [callback] - (Optional) callback function to handle the response.
+ * @returns {Operation}
+ */
 export function request(method: string, path: string, options: any, callback?: Function): Operation;
+/**
+ * The get function is used to make a GET request to the Mailchimp API.
+ * @example <caption>Get a list of account exports for a given account</caption>
+ * get('/account-exports');
+ * @function
+ * @param {string} path - The endpoint of the api to which the request should be made
+ * @param {object} query - An object containing query parameters to be included in the request
+ * @param {function} [callback] - (Optional) callback to handle the response
+ * @returns {Operation}
+ */
 export function get(path: string, query: object, callback?: Function): Operation;
+/**
+ * The post function is used to make a POST request to the Mailchimp API.
+ *
+ * @example <caption>Create a new account export in your Mailchimp account</caption>
+ * post('/accounts-export', {include_stages:[]});
+ * @function
+ * @param {string} path - The endpoint of the api to which the request should be made.
+ * @param {object} body - The data to be sent in the body of the request
+ * @param {object} query - An object containing query parameters to be included in the request
+ * @param {function} [callback] - (Optional) callback to handle the response
+ * @returns {Operation}
+ */
 export function post(path: string, body: object, query: object, callback?: Function): Operation;
 import axios from "axios";
 export { axios, md5 };