mysendingbox 1.1.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2025 Exaland.app
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,672 @@
+
+# mysendingbox-node
+
+  [![Node.js Package](https://github.com/exaland/mysendingbox-node/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/exaland/mysendingbox-node/actions/workflows/npm-publish.yml)
+
+[downloads-image]: http://img.shields.io/npm/dm/mysendingbox.svg
+
+[npm-url]: https://npmjs.org/package/mysendingbox
+
+[npm-image]: https://badge.fury.io/js/mysendingbox.svg
+
+  
+
+[![NPM version][npm-image]][npm-url] [![Dependency Status](https://gemnasium.com/badges/github.com/exaland/mysendingbox-node.svg)](https://gemnasium.com/github.com/exaland/mysendingbox-node)
+
+  
+  
+  
+
+MySendingBox.com Node.js Client is a simple but flexible wrapper for the [MySendingBox.fr](https://www.mysendingbox.fr) API.
+
+  
+
+See full Seeuletter.com documentation [here](https://docs.mysendingbox.fr/).
+
+  
+
+For best results, be sure that you're using the latest version of the Seeuletter API and the latest version of the Node.js wrapper.
+
+  
+
+#### French
+
+Un module NPM pour envoyer du courrier postal ou electronique en ligne depuis votre application Node.Js.
+
+  
+
+Seeuletter propose une API permettant d'envoyer très facilement du courrier postal ou électronique depuis votre ERP, CRM ou application web.
+
+  
+
+Pas de frais d'installation. Pas d'engagement. Vous payez ce que vous consommez.
+
+  
+
+Documentation : https://docs.mysendingbox.fr/
+
+  
+
+Bien démarrer : https://www.mysendingbox.fr/guide/bien-demarrer-avec-l-api-d-envoi-de-courrier
+
+  
+
+## Table of Contents
+
+  
+
+- [Getting Started](#getting-started)
+
+- [Registration](#registration)
+
+- [Installation](#installation)
+
+- [Letters](#letters)
+
+- [Postcards](#postcards)
+
+- [Price](#price) **new update**
+
+- [Accounts](#accounts)
+
+- [Invoices](#invoices)
+
+- [Examples](#examples)
+
+  
+
+## Getting Started
+
+  
+
+Here's a general overview of the Seeuletter services available, click through to read more.
+
+  
+
+Please read through the official [API Documentation](https://docs.mysendingbox.fr/) to get a complete sense of what to expect from each endpoint.
+
+  
+
+### Registration
+
+  
+
+First, you will need to first create an account at [Seeuletter.com](https://www.mysendingbox.fr/signup) and obtain your Test and Live API Keys.
+
+  
+
+Once you have created an account, you can access your API Keys from the [Settings Panel](https://www.mysendingbox.fr/app/dashboard/keys).
+
+  
+  
+
+### Installation
+
+  
+
+mysendingbox-node can be installed through the npm:
+
+  
+
+```
+
+$ npm install -S mysendingbox
+
+```
+
+  
+
+To build and install from the latest source:
+
+  
+
+```
+
+$ git clone git@github.com:exaland/mysendingbox-node.git
+
+$ npm install
+
+```
+
+  
+
+### Letters
+
+  
+
+#### Create a new letter - Callback style
+
+```javascript
+
+var  Seeuletter  =  require('mysendingbox')('YOUR API KEY');
+
+  
+
+// callback pattern
+
+Seeuletter.letters.create({
+
+description: 'Test Letter from the Node.js Wrapper',
+
+to: {
+
+name: 'Erlich',
+
+address_line1: '30 rue de rivoli',
+
+address_line2: '',
+
+address_city: 'Paris',
+
+address_country: 'France',
+
+address_postalcode: '75004'
+
+},
+
+postage_type: 'prioritaire',
+
+color: 'bw',
+
+source_file: '<html>Hello, {{nom}}</html>',
+
+source_file_type: 'html',
+
+variables: {
+
+nom : 'Seeuletter'
+
+}
+
+}, function  (err, body) {
+
+if (err) console.log('err : '  ,  err.message);
+
+console.log('body : ',  body)
+
+})
+
+```
+
+  
+
+#### Create a new letter - Promise style
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// promise pattern
+
+Seeuletter.letters.create({
+
+description: 'Test Letter from the Node.js Wrapper',
+
+to: {
+
+name: 'Erlich',
+
+address_line1: '30 rue de rivoli',
+
+address_line2: '',
+
+address_city: 'Paris',
+
+address_country: 'France',
+
+address_postalcode: '75004'
+
+},
+
+postage_type: 'prioritaire',
+
+color: 'bw',
+
+source_file: '<html>Hello, {{nom}}</html>',
+
+source_file_type: 'html',
+
+variables: {
+
+nom : 'Seeuletter'
+
+}
+
+})
+
+.then(function  (response) {
+
+console.log('response : ',  response);
+
+})
+
+.catch(function  (err) {
+
+console.log('err : ',  err);
+
+});
+
+```
+
+  
+
+#### Create a new electronic letter - Promise style
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// promise pattern
+
+Seeuletter.letters.createElectronic({
+
+description: 'Test electronic letter from the Node.js Wrapper',
+
+to: {
+
+email: 'erlich.dumas@example.com',
+
+first_name: 'Erlich',
+
+last_name: 'Dumas',
+
+status: 'individual'
+
+},
+
+postage_type: 'lre',
+
+content: 'Please review the attached documents:',
+
+source_file: '<html>Hello, {{nom}}</html>',
+
+source_file_type: 'html',
+
+variables: {
+
+nom : 'Seeuletter'
+
+}
+
+})
+
+.then(function  (response) {
+
+console.log('response : ',  response);
+
+})
+
+.catch(function  (err) {
+
+console.log('err : ',  err);
+
+});
+
+```
+
+  
+
+#### List all Letters
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('test_12345678901234567890')
+
+  
+
+Seeuletter.letters.list()
+
+.then(function  (response) {
+
+console.log('response : ',  response);
+
+})
+
+.catch(function  (err) {
+
+console.log('err : ',  err);
+
+});
+
+```
+
+  
+
+#### Retrieve a specific Letter
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('test_12345678901234567890')
+
+  
+
+Seeuletter.letters.retrieve('LETTER_ID')
+
+.then(function  (response) {
+
+console.log('response : ',  response);
+
+})
+
+.catch(function  (err) {
+
+console.log('err : ',  err);
+
+});
+
+```
+
+  
+
+### Postcards
+
+  
+
+#### Create a new postcard - Promise style
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Create the address
+
+Seeuletter.postcards.create({
+
+description: 'Test Postcard from the Node.js Wrapper',
+
+to: {
+
+name: 'Erlich',
+
+address_line1: '30 rue de rivoli',
+
+address_line2: '',
+
+address_city: 'Paris',
+
+address_country: 'France',
+
+address_postalcode: '75004'
+
+},
+
+// https://www.mysendingbox.fr/templates
+
+source_file_front: 'YOUR TEMPLATE ID',
+
+source_file_front_type: 'template_id',
+
+source_file_back: 'YOUR TEMPLATE ID',
+
+source_file_back_type: 'template_id',
+
+  
+
+variables: {
+
+PRENOM: 'Erlich',
+
+NOM: 'Bachman',
+
+CODE_PROMO_BIENVENUE: 'CODE',
+
+URL_COURTE_BIENVENUE: 'https://goo.gl/uqTHnD',
+
+ADRESSE: '30 rue de Rivoli',
+
+CODE_POSTAL : '75004',
+
+VILLE : 'Paris',
+
+PAYS : 'France'
+
+}
+
+})
+
+.then(function  (letter) {
+
+console.log('The Seeuletter API Postcard responded : ',  letter)
+
+})
+
+.catch(function  (err) {
+
+console.log('Error message : ',  err.message)
+
+})
+
+  
+
+```
+### Price
+
+  
+
+#### Get Price for MySendingBox- Promise style
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Get the Letter Price
+Seeuletter.LettersPrice.getPrice({
+
+// Letter type
+
+postage_type: 'ecopli',
+
+page_count: 11,
+
+channel: 'paper',
+
+color: 'color',
+
+pack: 'business',
+
+both_sides: false,
+
+postage_speed: 'express'
+
+}).then(function  (response) {
+
+console.log('[Get Price] The Seeuletter API responded : ',  response)
+
+}).catch(function  (err) {
+
+console.log('[Get Price] Error message : ',  err.message)
+
+console.log('[Get Price] Error status_code : ',  err.status_code)
+
+})
+  ```
+
+### Accounts
+
+  
+
+#### Create a new account for the company
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Create the account
+
+Seeuletter.accounts.create({
+
+email: "msb.partner@example.com",
+
+name: "Erlich Bachman",
+
+phone: "+33104050607",
+
+company_name: "MSB Partner",
+
+address_line1: '30 rue de rivoli',
+
+address_line2: '',
+
+address_city: 'Paris',
+
+address_country: 'France',
+
+address_postalcode: '75004'
+
+})
+
+.then(function  (account) {
+
+console.log('The Seeuletter API Account responded : ',  account)
+
+})
+
+.catch(function  (err) {
+
+console.log('Error message : ',  err.message)
+
+})
+
+  
+
+```
+
+  
+
+#### Update the account company email
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Update the account
+
+Seeuletter.accounts.updateEmail("ACCOUNT COMPANY ID", "UPDATED EMAIL")
+
+.then(function  () {
+
+console.log('The Seeuletter API Account responded with success')
+
+})
+
+.catch(function  (err) {
+
+console.log('Error message : ',  err.message)
+
+})
+
+  
+
+```
+
+  
+
+### Invoices
+
+  
+
+#### List all invoices for a company
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Getting the invoice list
+
+Seeuletter.invoices.list({
+
+// Pass optional filter here as object
+
+})
+
+.then(function  (response) {
+
+console.log('The Seeuletter API Invoices responded : ',  response)
+
+})
+
+.catch(function  (err) {
+
+console.log('Error message : ',  err.message)
+
+})
+
+  
+
+```
+
+  
+
+#### Retrieve a specific invoice
+
+  
+
+```javascript
+
+var  Seeuletter  =  require('seeuletter')('YOUR API KEY');
+
+  
+
+// Getting the invoice list
+
+Seeuletter.invoices.retrieve("INVOICE ID")
+
+.then(function  (invoice) {
+
+console.log('The Seeuletter API Invoice responded : ',  invoice)
+
+})
+
+.catch(function  (err) {
+
+console.log('Error message : ',  err.message)
+
+})
+
+  
+
+```
+
+  
+
+=======================
+
+  
+
+Copyright &copy; 2025 Exaland.app
+
+  
+
+Released under the MIT License, which can be found in the repository in `LICENSE.txt`.

package/lib/index.js

@@ -0,0 +1,60 @@
+'use strict';
+
+var resources     = require('./resources');
+var clientVersion = require('../package.json').version;
+
+var SEEULETTER_HOST      = 'https://api.mysendingbox.fr/';
+var SEEULETTER_USERAGENT = 'Seeuletter/v1 NodeBindings/' + clientVersion;
+
+var Seeuletter = function (apiKey, options) {
+
+  if (!(this instanceof Seeuletter)) {
+    return new Seeuletter(apiKey, options);
+  }
+
+  if (apiKey && typeof apiKey === 'object') {
+    if (apiKey.options && typeof apiKey.options === 'object') {
+      options = apiKey.options;
+      apiKey = apiKey.options.apiKey || null;
+    } else {
+      options = apiKey;
+      apiKey = apiKey.apiKey || null;
+    }
+  }
+
+  this.options = {
+    apiKey:    apiKey,
+    host:      SEEULETTER_HOST,
+    userAgent: SEEULETTER_USERAGENT,
+    headers: { 'user-agent': SEEULETTER_USERAGENT }
+  };
+
+  if (options && typeof options === 'object') {
+
+    if (options.hasOwnProperty('apiVersion')) {
+      this.options.headers['Seeuletter-Version'] = options.apiVersion;
+    }
+
+    for (var key in options) {
+      this.options[key] = options[key];
+    }
+
+  }
+
+  this._initResources();
+};
+
+(function () {
+
+  this._initResources = function () {
+    var services = Object.keys(resources);
+
+    for (var i = 0; i < services.length; i++) {
+      var service = services[i];
+      this[service] = new resources[service](this);
+    }
+  };
+
+}).call(Seeuletter.prototype);
+
+module.exports = Seeuletter;

package/lib/resources/accounts.js

@@ -0,0 +1,24 @@
+'use strict';
+
+var util         = require('util');
+var ResourceBase = require('./resourceBase');
+
+var Accounts = function (config) {
+  ResourceBase.call(this, 'accounts', Object.assign({}, config, { useBody: true }));
+};
+
+util.inherits(Accounts, ResourceBase);
+
+(function () {
+
+  this.create = function (params, callback) {
+    return this._transmit('POST', null, null, params, callback);
+  };
+
+  this.updateEmail = function (id, email, callback) {
+    return this._transmit('PUT', id, null, { email: email }, callback);
+  }
+
+}).call(Accounts.prototype);
+
+module.exports = Accounts;

package/lib/resources/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+var fs        = require('fs');
+var files     = fs.readdirSync(__dirname);
+var resources = {};
+
+for (var i = 0; i < files.length; i++) {
+  var resource = files[i];
+
+  if (resource === 'index.js' ||
+     resource === 'resourceBase.js' ||
+     resource.indexOf('.js') < 0) {
+    continue;
+  }
+
+  resource = resource.replace('.js', '');
+  resources[resource] = require('./' + resource);
+}
+
+module.exports = resources;

package/lib/resources/invoices.js

@@ -0,0 +1,29 @@
+'use strict';
+
+var util         = require('util');
+var ResourceBase = require('./resourceBase');
+
+var Invoices = function (config) {
+  ResourceBase.call(this, 'invoices', config);
+};
+
+util.inherits(Invoices, ResourceBase);
+
+(function () {
+
+  this.list = function (options, callback) {
+    if (typeof options === 'function') {
+      callback = options;
+      options  = {};
+    }
+
+    return this._transmit('GET', null, options, null, callback);
+  };
+
+  this.retrieve = function (id, callback) {
+    return this._transmit('GET', id, null, null, callback);
+  }
+
+}).call(Invoices.prototype);
+
+module.exports = Invoices;

package/lib/resources/letters.js

@@ -0,0 +1,44 @@
+'use strict';
+
+var util         = require('util');
+var ResourceBase = require('./resourceBase');
+
+const { processCreateResourceParams } = require('../utils/params');
+
+var Letters = function (config) {
+  ResourceBase.call(this, 'letters', config);
+};
+
+util.inherits(Letters, ResourceBase);
+
+(function () {
+
+  this.list = function (options, callback) {
+
+    if (typeof options === 'function') {
+      callback = options;
+      options  = {};
+    }
+
+    return this._transmit('GET', null, options, null, callback);
+  };
+
+  this.retrieve = function (id, callback) {
+    return this._transmit('GET', id, null, null, callback);
+  };
+
+  this.delete = function (id, callback) {
+    return this._transmit('DELETE', id, null, null, callback);
+  };
+
+  this.create = function (params, callback) {
+    return this._transmit('POST', null, null, processCreateResourceParams(params), callback);
+  };
+
+  this.createElectronic = function (params, callback) {
+    return this._transmit('POST', 'electronic', null, processCreateResourceParams(params), callback);
+  }
+
+}).call(Letters.prototype);
+
+module.exports = Letters;

package/lib/resources/postcards.js

@@ -0,0 +1,40 @@
+'use strict';
+
+var util         = require('util');
+var ResourceBase = require('./resourceBase');
+
+const { processCreateResourceParams } = require('../utils/params');
+
+var Postcards = function (config) {
+  ResourceBase.call(this, 'postcards', config);
+};
+
+util.inherits(Postcards, ResourceBase);
+
+(function () {
+
+  this.list = function (options, callback) {
+
+    if (typeof options === 'function') {
+      callback = options;
+      options  = {};
+    }
+
+    return this._transmit('GET', null, options, null, callback);
+  };
+
+  this.retrieve = function (id, callback) {
+    return this._transmit('GET', id, null, null, callback);
+  };
+
+  this.delete = function (id, callback) {
+    return this._transmit('DELETE', id, null, null, callback);
+  };
+
+  this.create = function (params, callback) {
+    return this._transmit('POST', null, null, processCreateResourceParams(params), callback);
+  };
+
+}).call(Postcards.prototype);
+
+module.exports = Postcards;

package/lib/resources/price.js

@@ -0,0 +1,34 @@
+'use strict';
+
+var util         = require('util');
+var ResourceBase = require('./resourceBase');
+
+const { processCreateResourceParams } = require('../utils/params');
+
+var LettersPrice = function (config) {
+  ResourceBase.call(this, 'letters/price', config);
+};
+
+util.inherits(LettersPrice, ResourceBase);
+
+(function () {
+
+  this.list = function (options, callback) {
+
+    if (typeof options === 'function') {
+      callback = options;
+      options  = {};
+    }
+
+    return this._transmit('GET', null, options, null, callback);
+  };
+
+
+  this.getPrice = function (params, callback) {
+    return this._transmit('POST', null, null, processCreateResourceParams(params), callback);
+  };
+
+
+}).call(LettersPrice.prototype);
+
+module.exports = LettersPrice;

package/lib/resources/resourceBase.js

@@ -0,0 +1,117 @@
+'use strict'
+
+const axios = require('axios')
+const stream = require('stream')
+
+var ResourceBase = function (endpoint, config) {
+ this.uri = config.options.host + endpoint
+   this.config = config.options
+   this.useBody = config.useBody || false
+
+};
+(function () {
+  this._transmit = function (method, uri, qs, form, headers, callback) {
+    if (typeof headers === 'function') {
+      callback = headers
+      headers = {}
+    } else {
+      headers = headers || {}
+    }
+
+    // Ajoutez ou mettez à jour les headers
+    for (let headerKey in this.config.headers) {
+      headers[headerKey] = this.config.headers[headerKey]
+    }
+
+    const url = this.uri + (uri ? '/' + uri : '')
+
+    // Préparer la configuration axios
+    const axiosConfig = {
+      url: url,
+      method: method,
+      headers: headers,
+      auth: {
+        username: this.config.apiKey,
+        password: ''
+      },
+      // Par défaut, axios sérialise en JSON
+      // Ajoutez des options spécifiques selon votre besoin
+    }
+
+    // Gestion des paramètres de requête
+    if (qs) {
+      axiosConfig.params = qs
+    }
+
+    // Gestion du corps de la requête
+    if (form) {
+      // Vérifier si le corps doit être envoyé en tant que formData
+      let isMultiPartForm = false
+      for (const key in form) {
+        const val = form[key]
+    if ((val instanceof stream.Stream) || (val && val.hasOwnProperty('value'))) {
+          isMultiPartForm = true
+          break
+        }
+      }
+
+      if (this.useBody) {
+        axiosConfig.data = form
+      } else if (isMultiPartForm) {
+        // Si vous utilisez des fichiers stream ou formData, utilisez form-data
+        const FormData = require('form-data')
+        const formData = new FormData()
+        for (const key in form) {
+          formData.append(key, form[key])
+        }
+        axiosConfig.data = formData
+        axiosConfig.headers = {
+          ...headers,
+          ...formData.getHeaders()
+        }
+      } else {
+        axiosConfig.data = form
+      }
+    }
+
+    // Appel axios avec gestion Promises
+    const promise = axios(axiosConfig)
+      .then(response => {
+        const body = response.data
+        // Ajout de la propriété _response
+        Object.defineProperty(body, '_response', {
+          enumerable: false,
+          writable: false,
+          value: response
+        })
+        return body
+      })
+      .catch(err => {
+        if (err.response) {
+          const resp = err.response
+          const body = resp.data
+          if (body && body.error) {
+            const error = new Error(body.error.message)
+            error.status_code = body.error.status_code || resp.status
+            error._response = resp
+            throw error
+          }
+          if (resp.status >= 500) {
+            const error = new Error(resp.statusText)
+            error.status_code = resp.status
+            error._response = resp
+            throw error
+          }
+        }
+        throw err
+      })
+
+    if (callback && typeof callback === 'function') {
+      promise.then(result => callback(null, result)).catch(err => callback(err))
+    } else {
+      return promise
+    }
+  }
+}).call(ResourceBase.prototype)
+
+module.exports = ResourceBase

package/lib/utils/params.js

@@ -0,0 +1,23 @@
+const flatten = require('flat');
+
+function processCreateResourceParams(params) {
+  const files = {};
+
+  Object.keys(params)
+    .filter(key => key.startsWith('source_file') && !key.endsWith('_type'))
+    .forEach(key => {
+      files[key] = Buffer.isBuffer(params[key]) 
+        ? {
+            value: params[key],
+            options: { filename: `${key}.pdf` }
+          } 
+        : params[key];
+      delete params[key];
+    });
+
+  return { ...flatten(params), ...files };
+}
+
+module.exports = {
+  processCreateResourceParams,
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "mysendingbox",
+  "description": "Mysendingbox API wrapper",
+  "keywords": [
+    "Mysendingbox",
+    "Mysendingbox-node",
+    "rest",
+    "exaland",
+    "api",
+    "wrapper",
+    "Mysendingbox.com",
+    "printing"
+  ],
+  "version": "1.1.0",
+  "homepage": "https://github.com/exaland/mysendingbox-node",
+  "author": "Exaland Concept For -> Mysendingbox <hello@mysendingbox.fr> (https://www.mysendingbox.fr/)",
+  "dependencies": {
+    "bluebird": "^3.7.2",
+    "flat": "^6.0.1",
+    "axios": "^1.16.1"
+  },
+  "devDependencies": {
+    "moment": "^2.30.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/exaland/mysendingbox-node.git"
+  },
+  "bugs:": "https://github.com/exaland/mysendingbox-node/issues",
+  "main": "./lib/index",
+  "engines": {
+    "node": ">= 0.10.0"
+  },
+  "files": [
+    "lib",
+    "LICENSE.txt"
+  ]
+}