@openfn/language-mailchimp 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,14 +6,20 @@
6
6
  "type": "string",
7
7
  "description": "Mailchimp API domain URL",
8
8
  "format": "uri",
9
- "minLength": 1
9
+ "minLength": 1,
10
+ "examples": [
11
+ "https://mailchimp.com/api"
12
+ ]
10
13
  },
11
14
  "apiKey": {
12
15
  "title": "API Key",
13
16
  "type": "string",
14
17
  "description": "Mailchimp API Key",
15
18
  "writeOnly": true,
16
- "minLength": 1
19
+ "minLength": 1,
20
+ "examples": [
21
+ "somEThINGkeyish"
22
+ ]
17
23
  }
18
24
  },
19
25
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfn/language-mailchimp",
3
- "version": "0.3.1",
3
+ "version": "0.3.3",
4
4
  "description": "An OpenFn adaptor for use with Mailchimp",
5
5
  "main": "dist/index.cjs",
6
6
  "author": "Open Function Group",
@@ -6,86 +6,38 @@
6
6
  * create('foo'),
7
7
  * delete('bar')
8
8
  * )(state)
9
- * @constructor
9
+ * @function
10
10
  * @param {Operations} operations - Operations to be performed.
11
11
  * @returns {Operation}
12
12
  */
13
13
  export function execute(...operations: Operations): Operation;
14
- export class execute {
15
- /**
16
- * Execute a sequence of operations.
17
- * Wraps `@openfn/language-common/execute`, and prepends initial state for http.
18
- * @example
19
- * execute(
20
- * create('foo'),
21
- * delete('bar')
22
- * )(state)
23
- * @constructor
24
- * @param {Operations} operations - Operations to be performed.
25
- * @returns {Operation}
26
- */
27
- constructor(...operations: Operations);
28
- }
29
14
  /**
30
15
  * Add members to a particular audience
31
16
  * @example
32
17
  * upsertMembers(params)
33
- * @constructor
18
+ * @function
34
19
  * @param {object} params - a listId, users, and options
35
20
  * @returns {Operation}
36
21
  */
37
22
  export function upsertMembers(params: object): Operation;
38
- export class upsertMembers {
39
- /**
40
- * Add members to a particular audience
41
- * @example
42
- * upsertMembers(params)
43
- * @constructor
44
- * @param {object} params - a listId, users, and options
45
- * @returns {Operation}
46
- */
47
- constructor(params: object);
48
- }
49
23
  /**
50
24
  * Tag members with a particular tag
51
25
  * @example
52
26
  * tagMembers(params)
53
- * @constructor
27
+ * @function
54
28
  * @param {object} params - a tagId, members, and a list
55
29
  * @returns {Operation}
56
30
  */
57
31
  export function tagMembers(params: object): Operation;
58
- export class tagMembers {
59
- /**
60
- * Tag members with a particular tag
61
- * @example
62
- * tagMembers(params)
63
- * @constructor
64
- * @param {object} params - a tagId, members, and a list
65
- * @returns {Operation}
66
- */
67
- constructor(params: object);
68
- }
69
32
  /**
70
33
  * Start a batch with a list of operations.
71
34
  * @example
72
35
  * startBatch(params)
73
- * @constructor
36
+ * @function
74
37
  * @param {object} params - operations batch job
75
38
  * @returns {Operation}
76
39
  */
77
40
  export function startBatch(params: object): Operation;
78
- export class startBatch {
79
- /**
80
- * Start a batch with a list of operations.
81
- * @example
82
- * startBatch(params)
83
- * @constructor
84
- * @param {object} params - operations batch job
85
- * @returns {Operation}
86
- */
87
- constructor(params: object);
88
- }
89
41
  export function listBatches(params: any): (state: any) => any;
90
42
  import axios from "axios";
91
43
  export { axios, md5 };