zudello-integration-sdk 1.0.0

package/src/sdk/Intacct.js

@@ -0,0 +1,103 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/intacct/Universal')
+const AccountModule = require('./submodules/intacct/Account')
+const AccountGroupModule = require('./submodules/intacct/AccountGroup')
+const AccountingPeriodModule = require('./submodules/intacct/AccountingPeriod')
+const ApTermModule = require('./submodules/intacct/ApTerm')
+const BudgetModule = require('./submodules/intacct/Budget')
+const ClassModule = require('./submodules/intacct/Class')
+const CostTypeModule = require('./submodules/intacct/CostType')
+const CustomerTypeModule = require('./submodules/intacct/CustomerType')
+const CustomerGroupModule = require('./submodules/intacct/CustomerGroup')
+const CustomerModule = require('./submodules/intacct/Customer')
+const DepartmentModule = require('./submodules/intacct/Department')
+const EmployeeModule = require('./submodules/intacct/Employee')
+const EntityModule = require('./submodules/intacct/Entity')
+const ItemModule = require('./submodules/intacct/Item')
+const ItemGroupModule = require('./submodules/intacct/ItemGroup')
+const LocationModule = require('./submodules/intacct/Location')
+const ProductLineModule = require('./submodules/intacct/ProductLine')
+const ProjectModule = require('./submodules/intacct/Project')
+const ProjectGroupModule = require('./submodules/intacct/ProjectGroup')
+const TaskModule = require('./submodules/intacct/Task')
+const TaxDetailModule = require('./submodules/intacct/TaxDetail')
+const TaxSolutionModule = require('./submodules/intacct/TaxSolution')
+const TaxGroupsModule = require('./submodules/intacct/TaxGroups')
+const UomModule = require('./submodules/intacct/Uom')
+const VendorModule = require('./submodules/intacct/Vendor')
+const VendorTypesModule = require('./submodules/intacct/VendorTypes')
+const VendorGroupModule = require('./submodules/intacct/VendorGroup')
+const WarehouseModule = require('./submodules/intacct/Warehouse')
+const ApBillModule = require('./submodules/intacct/ApBill')
+const ApAdjustmentModule = require('./submodules/intacct/ApAdjustment')
+const PoDocumentModule = require('./submodules/intacct/PoDocument')
+const ArTermModule = require('./submodules/intacct/ArTerm')
+const ArInvoiceModule = require('./submodules/intacct/ArInvoice')
+const ArAdjustmentModule = require('./submodules/intacct/ArAdjustment')
+const FileModule = require('./submodules/intacct/File')
+const ZoneModule = require('./submodules/intacct/Zone')
+
+class IntacctSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'intacct',
+      integrationName: 'Intacct',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+    this.item = new ItemModule(this)
+    this.itemGroup = new ItemGroupModule(this)
+    this.department = new DepartmentModule(this)
+    this.account = new AccountModule(this)
+    this.accountGroup = new AccountGroupModule(this)
+    this.accountingPeriod = new AccountingPeriodModule(this)
+    this.project = new ProjectModule(this)
+    this.projectGroup = new ProjectGroupModule(this)
+    this.task = new TaskModule(this)
+    this.taxGroups = new TaxGroupsModule(this)
+    this.taxDetails = new TaxDetailModule(this)
+    this.taxSolution = new TaxSolutionModule(this)
+    this.productLine = new ProductLineModule(this)
+    this.budget = new BudgetModule(this)
+    this.employee = new EmployeeModule(this)
+    this.apTerm = new ApTermModule(this)
+    this.warehouse = new WarehouseModule(this)
+    this.customer = new CustomerModule(this)
+    this.customerType = new CustomerTypeModule(this)
+    this.customerGroup = new CustomerGroupModule(this)
+    this.costType = new CostTypeModule(this)
+    this.vendorTypes = new VendorTypesModule(this)
+    this.vendorGroup = new VendorGroupModule(this)
+    this.vendor = new VendorModule(this)
+    this.location = new LocationModule(this)
+    this.entity = new EntityModule(this)
+    this.class = new ClassModule(this)
+    this.uom = new UomModule(this)
+    this.apBill = new ApBillModule(this)
+    this.apAdjustment = new ApAdjustmentModule(this)
+    this.poDocument = new PoDocumentModule(this)
+    this.arTerm = new ArTermModule(this)
+    this.arInvoice = new ArInvoiceModule(this)
+    this.arAdjustment = new ArAdjustmentModule(this)
+    this.zone = new ZoneModule(this)
+    this.file = new FileModule(this)
+  }
+}
+
+module.exports = IntacctSDK

package/src/sdk/JobReady.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/jobready/Universal')
+
+class JobReady extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'jobready',
+      integrationName: 'JobReady',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = JobReady

package/src/sdk/MYOBAcumatica.js

@@ -0,0 +1,33 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/myobAcumatica/Universal')
+const ODataModule = require('./submodules/myobAcumatica/OData')
+
+class MYOBAcumatica extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'myobAcumatica',
+      integrationName: 'MYOBAcumatica',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+    this.odata = new ODataModule(this)
+  }
+}
+
+module.exports = MYOBAcumatica

package/src/sdk/Netsuite.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/netsuite/Universal')
+
+class NetsuiteSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'netsuite',
+      integrationName: 'Netsuite',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = NetsuiteSDK

package/src/sdk/NetsuiteSOAP.js

@@ -0,0 +1,92 @@
+'use strict'
+
+const _ = require('lodash')
+
+const BaseSDK = require('./Base')
+const VendorBillModule = require('./submodules/netsuite-soap/VendorBill')
+const VendorCreditModule = require('./submodules/netsuite-soap/VendorCredit')
+const UniversalModule = require('./submodules/netsuite-soap/Universal')
+const UniversalTransactionModule = require('./submodules/netsuite-soap/UniversalTransaction')
+const PurchaseOrderModule = require('./submodules/netsuite-soap/PurchaseOrder')
+const ReceiptModule = require('./submodules/netsuite-soap/Receipt')
+
+class NetsuiteSoapSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'netsuite',
+      integrationName: 'NetsuiteSOAP',
+      loggerClass
+    })
+
+    this.transformToTypes = ['vendorBill', 'itemReceipt']
+
+    /**
+     * Create submodule instances.
+     */
+    this.vendorBill = new VendorBillModule(this)
+    this.vendorCredit = new VendorCreditModule(this)
+    this.universal = new UniversalModule(this)
+    this.universalTransaction = new UniversalTransactionModule(this)
+    this.purchaseOrder = new PurchaseOrderModule(this)
+    this.receipt = new ReceiptModule(this)
+  }
+
+  /**
+   * Transaction transform FROM.
+   * @param {array} transformFrom.
+   * @param {string} transformTo.
+   * @returns {object} Transformed Response.
+   */
+  async transform ({ transformFrom, transformTo }) {
+    const validateIncludes = this.validator.includes(this.transformToTypes, transformTo)
+
+    if (!validateIncludes.valid) {
+      return this.responseHandler.error(validateIncludes.errors)
+    }
+
+    const validateIsEmpty = this.validator.isEmpty({ transformFrom })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    return await this.makeRequest('GET', `${this.apiURL}/zintegrations/action/d751e693-6bbb-4c93-aff4-6561bba29f03`, {
+      mappable_parameters: {
+        transformFrom: {
+          value: transformFrom
+        },
+        transformTo: {
+          value: transformTo
+        }
+      }
+    })
+  }
+
+  parseFilters (entries) {
+    return _.map(entries, entry => {
+      return {
+        field: {
+          value: entry.field
+        },
+        operator: {
+          value: entry.operator
+        },
+        value: {
+          value: entry.value
+        }
+      }
+    })
+  }
+}
+
+module.exports = NetsuiteSoapSDK

package/src/sdk/Nexvia.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/nexvia/Universal')
+
+class NexviaSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'nexvia',
+      integrationName: 'Nexvia',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = NexviaSDK

package/src/sdk/RetailExpress.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/retailExpress/Universal')
+
+class RetailExpress extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'retailExpress',
+      integrationName: 'RetailExpress',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = RetailExpress

package/src/sdk/Sybiz.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/sybiz/Universal')
+
+class Sybiz extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'sybiz',
+      integrationName: 'Sybiz',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = Sybiz

package/src/sdk/Zenoti.js

@@ -0,0 +1,31 @@
+'use strict'
+
+const BaseSDK = require('./Base')
+const UniversalModule = require('./submodules/zenoti/Universal')
+
+class ZenotiSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, connectionUUID, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      connectionUUID,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      appUUIDKey: 'zenoti',
+      integrationName: 'Zenoti',
+      loggerClass
+    })
+
+    /**
+     * Create submodule instances.
+     */
+    this.universal = new UniversalModule(this)
+  }
+}
+
+module.exports = ZenotiSDK

package/src/sdk/Zudello.js

@@ -0,0 +1,206 @@
+'use strict'
+
+const _ = require('lodash')
+
+const BaseSDK = require('./Base')
+const AccountModule = require('./submodules/zudello/Account')
+const AccountGroupModule = require('./submodules/zudello/AccountGroup')
+const AccountingPeriodModule = require('./submodules/zudello/AccountingPeriod')
+const CostCentreModule = require('./submodules/zudello/CostCentre')
+const CostTypeModule = require('./submodules/zudello/CostType')
+const CustomerModule = require('./submodules/zudello/Customer')
+const CustomerCategoryModule = require('./submodules/zudello/CustomerCategory')
+const CustomerGroupModule = require('./submodules/zudello/CustomerGroup')
+const CurrencyModule = require('./submodules/zudello/Currency')
+const DepartmentModule = require('./submodules/zudello/Department')
+const EmployeeModule = require('./submodules/zudello/Employee')
+const SubsidiaryModule = require('./submodules/zudello/Subsidiary')
+const LocationModule = require('./submodules/zudello/Location')
+const TaxRateModule = require('./submodules/zudello/tax/Rate')
+const TaxSolutionModule = require('./submodules/zudello/tax/Solution')
+const ItemModule = require('./submodules/zudello/Item')
+const ItemCategoryModule = require('./submodules/zudello/ItemCategory')
+const ItemGroupModule = require('./submodules/zudello/ItemGroup')
+const PurchaseOrderModule = require('./submodules/zudello/PurchaseOrder')
+const PaymentTermModule = require('./submodules/zudello/PaymentTerm')
+const PaymentMethodModule = require('./submodules/zudello/PaymentMethod')
+const ProjectModule = require('./submodules/zudello/Project')
+const ProjectGroupModule = require('./submodules/zudello/ProjectGroup')
+const ProjectTaskModule = require('./submodules/zudello/ProjectTask')
+const SupplierCategoryModule = require('./submodules/zudello/SupplierCategory')
+const SupplierGroupModule = require('./submodules/zudello/SupplierGroup')
+const UomModule = require('./submodules/zudello/Uom')
+const WarehouseModule = require('./submodules/zudello/Warehouse')
+const ZoneModule = require('./submodules/zudello/Zone')
+const SupplierModule = require('./submodules/zudello/Supplier')
+const FixedAssetModule = require('./submodules/zudello/FixedAsset')
+const UniversalModule = require('./submodules/zudello/Universal')
+
+class ZudelloSDK extends BaseSDK {
+  /**
+   * Constructor.
+   * @param {class} auth Auth class object with authorized api instance.
+   * @param {string} connectionUUID The UUID of the Connection we're working on.
+   */
+  constructor (auth, organizationUUID, apiURL, apiVersion, loggerClass = null) {
+    super({
+      auth,
+      organizationUUID,
+      apiURL,
+      apiVersion,
+      isExternal: false,
+      integrationName: 'Zudello',
+      loggerClass
+    })
+
+    this.staticFieldsForUpdate = {
+      enrich: false,
+      extractedEvent: false,
+      update: true
+    }
+
+    /**
+     * Create submodule instances.
+     */
+    this.account = new AccountModule(this)
+    this.accountGroup = new AccountGroupModule(this)
+    this.accountingPeriod = new AccountingPeriodModule(this)
+    this.costCentre = new CostCentreModule(this)
+    this.costType = new CostTypeModule(this)
+    this.customer = new CustomerModule(this)
+    this.customerCategory = new CustomerCategoryModule(this)
+    this.customerGroup = new CustomerGroupModule(this)
+    this.currency = new CurrencyModule(this)
+    this.department = new DepartmentModule(this)
+    this.employee = new EmployeeModule(this)
+    this.subsidiary = new SubsidiaryModule(this)
+    this.location = new LocationModule(this)
+    this.item = new ItemModule(this)
+    this.itemCategory = new ItemCategoryModule(this)
+    this.itemGroup = new ItemGroupModule(this)
+    this.purchaseOrder = new PurchaseOrderModule(this)
+    this.paymentTerm = new PaymentTermModule(this)
+    this.paymentMethod = new PaymentMethodModule(this)
+    this.project = new ProjectModule(this)
+    this.projectGroup = new ProjectGroupModule(this)
+    this.projectTask = new ProjectTaskModule(this)
+    this.supplierCategory = new SupplierCategoryModule(this)
+    this.supplierGroup = new SupplierGroupModule(this)
+    this.warehouse = new WarehouseModule(this)
+    this.uom = new UomModule(this)
+    this.zone = new ZoneModule(this)
+    this.supplier = new SupplierModule(this)
+    this.fixedAsset = new FixedAssetModule(this)
+    this.universal = new UniversalModule(this)
+    this.tax = {
+      rate: new TaxRateModule(this),
+      solution: new TaxSolutionModule(this)
+    }
+  }
+
+  async search ({ model, select, filter, orderBy = ['-created_at'], offset = 0, limit = 100 }) {
+    const validateIsEmpty = this.validator.isEmpty({ model, select, filter })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    return await this.makeRequest('POST', `${this.apiURL}/team-data/${this.apiVersion}/resources/search`, {
+      model,
+      offset,
+      limit,
+      select,
+      order_by: orderBy,
+      filter,
+      exclude: {},
+      annotate: {}
+    })
+  }
+
+  async fetch ({ model, uuid, fetchDetails = true, simplified = true }) {
+    const validateIsEmpty = this.validator.isEmpty({ model, uuid })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    return await this.makeRequest('GET', `${this.apiURL}/team-data/${this.apiVersion}/resources`, {
+      model,
+      uuid,
+      fetch_details: fetchDetails,
+      simplified,
+    })
+  }
+
+  async getFileAttachment ({ uuid, type }) {
+    const validateIsEmpty = this.validator.isEmpty({ uuid, type })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    if (!['EXTRACTED', 'OCR'].includes(type)) {
+      return this.responseHandler.error('The attachment type can either be EXTRACTED or OCR')
+    }
+
+    return await this.makeRequest('GET', `${this.apiURL}/team-data/${this.apiVersion}/files/download/Transaction/${uuid}/${type}`, {}, {}, true)
+  }
+
+  async update ({ model, module = null, submodule = null, data, clearNulls = true, simplified = false, submit = false, updateStatus = false }) {
+    const validateIsEmpty = this.validator.isEmpty({ model, data })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    data = this.mapUpdateOrCreateData({
+      data: [data],
+      staticFields: {
+        ...this.staticFieldsForUpdate,
+        model,
+        module,
+        submodule
+      },
+      submit,
+      updateStatus
+    })
+
+    return await this.updateOrCreate({ data, clearNulls, simplified })
+  }
+
+  async updateOrCreate ({ data, clearNulls = true, simplified = false }) {
+    const validateIsEmpty = this.validator.isEmpty({ data })
+
+    if (!validateIsEmpty.valid) {
+      return this.responseHandler.error(validateIsEmpty.errors)
+    }
+
+    return await this.makeRequest('POST', `${this.apiURL}/team-data/${this.apiVersion}/resources/update_or_create`, {
+      simplified,
+      clear_nulls: clearNulls,
+      data
+    })
+  }
+
+  mapUpdateOrCreateData ({ data = [], staticFields = {}, submit = false, updateStatus = false }) {
+    return _.map(data, (item) => {
+      return {
+        data: {
+          module: staticFields.module,
+          submodule: staticFields.submodule,
+          document_type: staticFields.documentType,
+          ...item
+        },
+        model: staticFields.model,
+        submit: submit,
+        enrich: staticFields.enrich,
+        extracted_event: staticFields.extractedEvent,
+        update_status: updateStatus,
+        update: staticFields.update,
+        create: staticFields.create
+      }
+    })
+  }
+}
+
+module.exports = ZudelloSDK