xcoobee-sdk/src/xcoobee/sdk/index.js

The XcooBee SDK is a facility to abstract lower level calls and implement standard behaviors. The XcooBee team is providing this to improve the speed of implementation and show the best practices while interacting with XcooBee.

const Config = require('./Config');
const ConfigUtils = require('./ConfigUtils');
const Sdk = require('./Sdk');
const Utilities = require('./Utilities');

/**
 * The XcooBee SDK JavaScript module. It may be imported with whatever name you
 * prefer. In this API documentation, we'll use `SdkJs`.
 *
 * ```js
 * const XcooBee = require('xcoobee-sdk');
 * ```
 *
 * @module SdkJs
 */
module.exports = {
  /**
   * A reference to the XcooBee SDK `Config` class.
   *
   * ```js
   * const XcooBee = require('xcoobee-sdk');
   *
   * const config = new XcooBee.Config({ ... });
   * ```
   *
   * @memberof SdkJs
   */
  Config,
  /**
   * A reference to the XcooBee SDK `ConfigUtils` namespace.
   *
   * ```js
   * const XcooBee = require('xcoobee-sdk');
   *
   * XcooBee.ConfigUtils.createFromFile(...)
   *   .then(config => {
   *     // Do something with the config such as
   *     // pass it to the `Sdk` constuctor.
   *   });
   * ```
   *
   * @memberof SdkJs
   */
  ConfigUtils,
  /**
   * A reference to the XcooBee `Sdk` class.
   *
   * ```js
   * const XcooBee = require('xcoobee-sdk');
   *
   * const sdk = new XcooBee.Sdk(...);
   * ```
   *
   * @memberof SdkJs
   */
  Sdk,
  /**
     * A reference to XcooBee additional helpers and utilities
     * that can be used independently of SDK
     *
     * ```js
     * const XcooBee = require('xcoobee-sdk');
     *
     * XcooBee.Utilities.uploadFiles(files, policies)
     *  .then(...);
     * ```
    */
  Utilities,
};