@openfn/language-mailchimp 0.6.0 → 0.7.1

package/ast.json

@@ -418,6 +418,59 @@
         ]
       },
       "valid": true
+    },
+    {
+      "name": "chunk",
+      "params": [
+        "array",
+        "chunkSize"
+      ],
+      "docs": {
+        "description": "Chunks an array into an array of arrays, each with no more than a certain size.",
+        "tags": [
+          {
+            "title": "public",
+            "description": null,
+            "type": null
+          },
+          {
+            "title": "example",
+            "description": "chunk([1,2,3,4,5], 2)"
+          },
+          {
+            "title": "function",
+            "description": null,
+            "name": null
+          },
+          {
+            "title": "param",
+            "description": "Array to be chunked",
+            "type": {
+              "type": "NameExpression",
+              "name": "Object"
+            },
+            "name": "array"
+          },
+          {
+            "title": "param",
+            "description": "The maxiumum size of each chunks",
+            "type": {
+              "type": "NameExpression",
+              "name": "Integer"
+            },
+            "name": "chunkSize"
+          },
+          {
+            "title": "returns",
+            "description": null,
+            "type": {
+              "type": "NameExpression",
+              "name": "Object"
+            }
+          }
+        ]
+      },
+      "valid": true
     }
   ]
 }

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

@@ -29,6 +29,7 @@ __export(src_exports, {
   alterState: () => import_language_common3.alterState,
   archiveMember: () => archiveMember,
   axios: () => import_axios.default,
+  chunk: () => import_language_common3.chunk,
   dataPath: () => import_language_common3.dataPath,
   dataValue: () => import_language_common3.dataValue,
   default: () => src_default,
@@ -64,6 +65,7 @@ __export(Adaptor_exports, {
   alterState: () => import_language_common3.alterState,
   archiveMember: () => archiveMember,
   axios: () => import_axios.default,
+  chunk: () => import_language_common3.chunk,
   dataPath: () => import_language_common3.dataPath,
   dataValue: () => import_language_common3.dataValue,
   deleteMember: () => deleteMember,
@@ -250,15 +252,20 @@ var defaultOptions = {
   body: void 0
 };
 var assertOK = (response, fullUrl) => {
-  if (response.statusCode >= 400) {
-    const defaultErrorMesssage = `Request to ${fullUrl} failed with status: ${response.statusCode}`;
+  if (response.status >= 400) {
+    const defaultErrorMesssage = `Request to ${fullUrl} failed with status: ${response.status}`;
     const error = new Error(defaultErrorMesssage);
-    error.code = response.statusCode;
     error.url = fullUrl;
+    error.type = response.type;
+    error.title = response.title;
+    error.status = response.status;
+    error.detail = response.detail;
+    error.instance = response.instance;
+    error.errors = response.errors;
     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;
@@ -284,9 +291,11 @@ var request = (method, path, options, callback) => {
       query,
       body: body ? JSON.stringify(body) : void 0
     });
-    assertOK(response, `https://${server}.api.mailchimp.com${urlPath}`);
+    console.log("Mailchimp says", response.statusCode);
     const responseBody = await response.body.json();
+    assertOK(responseBody, `https://${server}.api.mailchimp.com${urlPath}`);
     const nextState = {
+      ...state,
       data: responseBody,
       response: responseBody
     };
@@ -294,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;
@@ -306,6 +319,7 @@ var src_default = Adaptor_exports;
   alterState,
   archiveMember,
   axios,
+  chunk,
   dataPath,
   dataValue,
   deleteMember,

package/dist/index.js

@@ -11,6 +11,7 @@ __export(Adaptor_exports, {
   alterState: () => alterState,
   archiveMember: () => archiveMember,
   axios: () => axios,
+  chunk: () => chunk,
   dataPath: () => dataPath,
   dataValue: () => dataValue,
   deleteMember: () => deleteMember,
@@ -73,6 +74,7 @@ import {
   fields,
   lastReferenceValue,
   merge,
+  chunk,
   sourceValue
 } from "@openfn/language-common";
 function execute(...operations) {
@@ -208,15 +210,20 @@ var defaultOptions = {
   body: void 0
 };
 var assertOK = (response, fullUrl) => {
-  if (response.statusCode >= 400) {
-    const defaultErrorMesssage = `Request to ${fullUrl} failed with status: ${response.statusCode}`;
+  if (response.status >= 400) {
+    const defaultErrorMesssage = `Request to ${fullUrl} failed with status: ${response.status}`;
     const error = new Error(defaultErrorMesssage);
-    error.code = response.statusCode;
     error.url = fullUrl;
+    error.type = response.type;
+    error.title = response.title;
+    error.status = response.status;
+    error.detail = response.detail;
+    error.instance = response.instance;
+    error.errors = response.errors;
     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;
@@ -242,9 +249,11 @@ var request = (method, path, options, callback) => {
       query,
       body: body ? JSON.stringify(body) : void 0
     });
-    assertOK(response, `https://${server}.api.mailchimp.com${urlPath}`);
+    console.log("Mailchimp says", response.statusCode);
     const responseBody = await response.body.json();
+    assertOK(responseBody, `https://${server}.api.mailchimp.com${urlPath}`);
     const nextState = {
+      ...state,
       data: responseBody,
       response: responseBody
     };
@@ -252,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;
@@ -263,6 +276,7 @@ export {
   alterState,
   archiveMember,
   axios,
+  chunk,
   dataPath,
   dataValue,
   src_default as default,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfn/language-mailchimp",
-  "version": "0.6.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,9 +133,44 @@ 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 };
-export { fn, alterState, dataPath, dataValue, each, field, fields, lastReferenceValue, merge, sourceValue } from "@openfn/language-common";
+export { fn, alterState, dataPath, dataValue, each, field, fields, lastReferenceValue, merge, chunk, sourceValue } from "@openfn/language-common";