dymo-api 1.0.50 → 1.0.52

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.
@@ -174,6 +174,11 @@ class DymoAPI {
174
174
  * @param {Object} [data.options] - Content configuration options.
175
175
  * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
176
176
  * @param {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
177
+ * @param {Attachment[]} [data.attachments] - An array of attachments to be included in the email.
178
+ * @param {string} data.attachments[].filename - The name of the attached file.
179
+ * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
180
+ * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
181
+ * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
177
182
  * @returns {Promise<Object>} A promise that resolves to the response from the server.
178
183
  * @throws Will throw an error if there is an issue with the email sending process.
179
184
  */
@@ -174,6 +174,11 @@ class DymoAPI {
174
174
  * @param {Object} [data.options] - Content configuration options.
175
175
  * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
176
176
  * @param {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
177
+ * @param {Attachment[]} [data.attachments] - An array of attachments to be included in the email.
178
+ * @param {string} data.attachments[].filename - The name of the attached file.
179
+ * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
180
+ * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
181
+ * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
177
182
  * @returns {Promise<Object>} A promise that resolves to the response from the server.
178
183
  * @throws Will throw an error if there is an issue with the email sending process.
179
184
  */
@@ -105,6 +105,11 @@ declare class DymoAPI {
105
105
  * @param {Object} [data.options] - Content configuration options.
106
106
  * @param {"high" | "normal" | "low" | undefined} [data.options.priority="normal"] - Email priority (default: normal).
107
107
  * @param {boolean} [data.options.composeTailwindClasses] - Whether to compose tailwind classes.
108
+ * @param {Attachment[]} [data.attachments] - An array of attachments to be included in the email.
109
+ * @param {string} data.attachments[].filename - The name of the attached file.
110
+ * @param {string} [data.attachments[].path] - The path or URL of the attached file. Either this or `content` must be provided.
111
+ * @param {Buffer} [data.attachments[].content] - The content of the attached file as a Buffer. Either this or `path` must be provided.
112
+ * @param {string} [data.attachments[].cid] - The CID (Content-ID) of the attached file, used for inline images.
108
113
  * @returns {Promise<Object>} A promise that resolves to the response from the server.
109
114
  * @throws Will throw an error if there is an issue with the email sending process.
110
115
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dymo-api",
3
- "version": "1.0.50",
3
+ "version": "1.0.52",
4
4
  "description": "Flow system for Dymo API.",
5
5
  "main": "dist/cjs/dymo-api.js",
6
6
  "module": "dist/esm/dymo-api.js",