merchi_sdk_js 0.0.1

package/src/set.js

@@ -0,0 +1,28 @@
+import { Dictionary } from './dictionary.js';
+
+export function Set() {
+
+    var store = new Dictionary();
+
+    this.add = function (value) {
+        store.add(value, value);
+    };
+
+    this.has = function (value) {
+        return store.has(value);
+    };
+
+    this.each = function (procedure) {
+        store.each(function (name, value) { procedure(value); });
+        return this;
+    };
+
+    this.values = function () {
+        return store.values();
+    };
+
+    this.remove = function (value) {
+        store.remove(value);
+        return this;
+    };
+}

package/src/shipment.js

@@ -0,0 +1,191 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, getOne, fromJson, enumerateFiles, serialise, patchOne,
+    deleteOne, fromJsonList, getList, create } from './model.js';
+import { removeObjectFromArrayWithIntegerValue } from './helpers.js';
+import { Address } from './address.js';
+import { Assignment } from './assignment.js';
+import { CountryTax } from './country_tax.js';
+import { DomainTag } from './domain_tag.js';
+import { User } from './user.js';
+import { Company } from './company.js';
+import { Invoice } from './invoice.js';
+import { Job } from './job.js';
+import { MerchiFile } from './merchi_file.js';
+import { ShipmentItem } from './shipment_item.js';
+import { ShipmentMethod } from './shipment_method.js';
+import { InternalTag } from './internal_tag.js';
+
+export function Shipment() {
+    this.resource = '/shipments';
+    this.json = 'shipment';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'pickUp');
+    addPropertyTo(this, 'shipmentServiceBookingInfo');
+    addPropertyTo(this, 'shipmentServiceQuote');
+    addPropertyTo(this, 'shipmentLabel', MerchiFile);
+    addPropertyTo(this, 'creationDate');
+    addPropertyTo(this, 'dispatchDate');
+    addPropertyTo(this, 'dispatchedDate');
+    addPropertyTo(this, 'expectedReceiveDate');
+    addPropertyTo(this, 'receivedDate');
+    addPropertyTo(this, 'sender', User);
+    addPropertyTo(this, 'senderCompany', Company);
+    addPropertyTo(this, 'senderAddress', Address);
+    addPropertyTo(this, 'senderNotes');
+    addPropertyTo(this, 'blindShipTo');
+    addPropertyTo(this, 'receiver', User);
+    addPropertyTo(this, 'receiverCompany', Company);
+    addPropertyTo(this, 'receiverAddress', Address);
+    addPropertyTo(this, 'receiverNotes');
+    addPropertyTo(this, 'invoices', Invoice);
+    addPropertyTo(this, 'jobs', Job);
+    addPropertyTo(this, 'assignments', Assignment);
+    addPropertyTo(this, 'trackingNumber');
+    addPropertyTo(this, 'transportCompany');
+    addPropertyTo(this, 'transportCompanyName');
+    addPropertyTo(this, 'sendSms');
+    addPropertyTo(this, 'sendEmail');
+    addPropertyTo(this, 'cost');
+    addPropertyTo(this, 'taxAmount');
+    addPropertyTo(this, 'maxWeight');
+    addPropertyTo(this, 'maxVolume');
+    addPropertyTo(this, 'taxType', CountryTax);
+    addPropertyTo(this, 'senderResponsible');
+    addPropertyTo(this, 'tags', DomainTag);
+    addPropertyTo(this, 'shipmentItems', ShipmentItem)
+    addPropertyTo(this, 'shipmentMethod', ShipmentMethod);
+    addPropertyTo(this, 'internalTags', InternalTag);
+
+    this.get = function (success, error, embed) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        getOne({resource: this.resource,
+                id: this.id(),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+     };
+
+    this.create = function (options) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            options.success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: options.error,
+                embed: options.embed});
+    };
+
+   this.patch = function (success, error, data, embed) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  data: data,
+                  embed: embed});
+    };
+
+    this.update = function (options) {
+        var self = this;
+        this.patch(options.success,
+            options.error,
+            serialise(self, undefined, undefined, undefined,
+                      {excludeOld: true})[0],
+            options.embed);
+    };
+
+    this.destroy = function (success, error) {
+        deleteOne(this.resource + "/" + this.id(), success, error);
+    };
+
+    this.hasJobs = function () {
+        return Boolean(this.jobs()) && this.jobs().length > 0;
+    };
+
+    this.hasJob = function (job) {
+        var jobIndex = this.jobs().findIndex(function (shipmentJob) {
+            return shipmentJob.id() === job.id();
+        });
+        return jobIndex >= 0;
+    };
+
+    this.hasAssignments = function () {
+        return Boolean(this.assignments()) && this.assignments().length > 0;
+    };
+
+    this.hasAssignment = function (assignment) {
+        var assignments = this.assignments(),
+            assignmentIndex;
+        if (Boolean(assignments)) {
+            assignmentIndex = assignments.findIndex(
+                function (shipmentAssignment) {
+                    return shipmentAssignment.id() === assignment.id();
+                });
+            return assignmentIndex >= 0;
+        }
+        return false;
+    };
+
+    this.removeAssignment = function (assignmentId) {
+        var self = this;
+        if (Boolean(assignmentId) && assignmentId !== '') {
+            removeObjectFromArrayWithIntegerValue(self.assignments(),
+                                                  'id', assignmentId);
+        }
+    };
+
+    this.removeJob = function (jobId) {
+        var self = this;
+        if (Boolean(jobId) && jobId !== '') {
+            removeObjectFromArrayWithIntegerValue(self.jobs(), 'id', jobId);
+        }
+    };
+
+    this.readyForDispatchedNotification = function () {
+        var self = this;
+        return Boolean(self.id() && self.trackingNumber() &&
+            self.transportCompany() && self.dispatchedDate());
+    };
+
+    this.userIsResponsible = function (user) {
+        var senderResponsible = this.senderResponsible(),
+            shipmentUser = senderResponsible ?
+                this.sender() : this.receiver();
+        return shipmentUser && shipmentUser.id() === user.id();
+    };
+
+    this.responsibleCompany = function () {
+        return this.senderResponsible() ?
+            this.senderCompany() : this.receiverCompany();
+    };
+}
+
+export function Shipments() {
+    this.resource = '/shipments';
+    this.json = 'shipments';
+    this.single = Shipment;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                parameters);
+    };
+}

package/src/shipment_item.js

@@ -0,0 +1,13 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo } from './model.js';
+import { ShipmentItemFulfillment } from './shipment_item_fulfillment.js';
+import { Job } from './job.js';
+
+export function ShipmentItem() {
+    this.resource = '/shipment_items';
+    this.json = 'shipmentItem';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'job', Job);
+    addPropertyTo(this, 'fulfillments', ShipmentItemFulfillment);
+}

package/src/shipment_item_fulfillment.js

@@ -0,0 +1,13 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo } from './model.js';
+import { Assignment } from './assignment.js';
+import { Job } from './job.js';
+
+export function ShipmentItemFulfillment() {
+    this.resource = '/shipment_item_fulfillments';
+    this.json = 'shipmentItemFulfillment';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'assignment', Assignment);
+    addPropertyTo(this, 'job', Job);
+}

package/src/shipment_method.js

@@ -0,0 +1,73 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, create, serialise, fromJson, enumerateFiles, patchOne,
+    fromJsonList, getList } from './model.js';
+import { Address } from './address.js';
+import { CountryTax } from './country_tax.js';
+import { Company } from './company.js';
+import { ShipmentMethodVariation } from './shipment_method_variation.js';
+
+export function ShipmentMethod() {
+    this.resource = '/shipment_methods';
+    this.json = 'shipmentMethod';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'shipmentService');
+    addPropertyTo(this, 'pickUp');
+    addPropertyTo(this, 'originAddress', Address);
+    addPropertyTo(this, 'company', Company);
+    addPropertyTo(this, 'companyDefault');
+    addPropertyTo(this, 'defaultCost');
+    addPropertyTo(this, 'maxCost');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'transportCompany');
+    addPropertyTo(this, 'transportCompanyName');
+    addPropertyTo(this, 'variations', ShipmentMethodVariation);
+    addPropertyTo(this, 'taxType', CountryTax);
+
+    this.create = function (success, error, embed, domainId) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed,
+                as_domain: domainId});
+    };
+    this.patch = function (success, error, embed) {
+        var self = this,
+            data = serialise(this, undefined, undefined, undefined,
+                             {excludeOld: true})[0];
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  data: data,
+                  embed: embed});
+    };
+}
+
+export function ShipmentMethods() {
+    this.resource = '/shipment_methods';
+    this.json = 'shipmentMethods';
+    this.single = ShipmentMethod;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                parameters);
+    };
+}

package/src/shipment_method_variation.js

@@ -0,0 +1,34 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJsonList, getList } from './model.js';
+import { CountryTax } from './country_tax.js';
+import { ShipmentMethod } from './shipment_method.js';
+
+export function ShipmentMethodVariation() {
+    this.resource = '/shipment_method_variations';
+    this.json = 'shipmentMethodVariation';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'destinationCountry');
+    addPropertyTo(this, 'destinationState');
+    addPropertyTo(this, 'cost');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'maxWeight');
+    addPropertyTo(this, 'shipmentMethod', ShipmentMethod);
+    addPropertyTo(this, 'taxType', CountryTax);
+}
+
+export function ShipmentMethodVariations() {
+    this.resource = '/shipment_method_variations';
+    this.json = 'shipmentMethodVariations';
+    this.single = ShipmentMethodVariation;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                parameters);
+    };
+}

package/src/subscription_plan.js

@@ -0,0 +1,68 @@
+import { addPropertyTo, serialise, fromJson, create, enumerateFiles, getList,
+    fromJsonList, getOne } from './model.js';
+import { User } from './user.js';
+import { CountryTax } from './country_tax.js';
+
+export function SubscriptionPlan() {
+    this.resource = '/subscription_plans';
+    this.json = 'subscriptionPlan';
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'created');
+    addPropertyTo(this, 'updated');
+    addPropertyTo(this, 'createdBy', User);
+    addPropertyTo(this, 'updatedBy', User);
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'tax', CountryTax);
+    addPropertyTo(this, 'baseCost');
+    addPropertyTo(this, 'whiteLabelDomainCost');
+    addPropertyTo(this, 'perSmsCost');
+    addPropertyTo(this, 'perUserCost');
+    addPropertyTo(this, 'perDomainCost');
+    addPropertyTo(this, 'baseUserCount');
+    addPropertyTo(this, 'baseDomainCount');
+    addPropertyTo(this, 'billingCycleDays');
+    addPropertyTo(this, 'isPrivate');
+
+   this.create = function (success, error, embed, as_domain) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: as_domain,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+    };
+
+    this.get = function (success, error) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        getOne({resource: this.resource,
+                id: this.id(),
+                success: handleResponse,
+                error: error});
+    };
+}
+
+export function SubscriptionPlans() {
+    this.resource = '/subscription_plans';
+    this.json = 'subscriptionPlans';
+    this.single = SubscriptionPlan;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error, parameters);
+    };
+}

package/src/supply_domain.js

@@ -0,0 +1,60 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson, getOne, getList, serialise, create,
+    fromJsonList, enumerateFiles } from './model.js';
+import { Product } from './product.js';
+import { Domain } from './domain.js';
+
+export function SupplyDomain() {
+    this.resource = '/supply_domains';
+    this.json = 'supplyDomain';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'needsDrafting');
+    addPropertyTo(this, 'product', Product);
+    addPropertyTo(this, 'supplyProduct', Product);
+    addPropertyTo(this, 'domain', Domain);
+
+    this.get = function (success, error) {
+        var self = this;
+        function handleResponse(result) {
+          success(fromJson(self, result[self.json],
+                           {makesDirty: false}));
+        }
+        getOne({resource: this.resource,
+                id: this.id(),
+                success: handleResponse,
+                error: error});
+    };
+
+    this.create = function (success, error, embed, as_domain) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+          success(fromJson(self, result[self.json]));
+        }
+
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: as_domain,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                data: error,
+                embed: embed});
+    };
+}
+
+export function SupplyDomains() {
+    this.resource = '/supply_domains';
+    this.json = 'supplyDomain';
+    this.single = SupplyDomain;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+          success(fromJsonList(self, result,
+                               {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error, parameters);
+    };
+}

package/src/system_role.js

@@ -0,0 +1,8 @@
+import { addPropertyTo } from './model.js';
+
+export function SystemRole() {
+    this.resource = '/system_roles';
+    this.json = 'systemRole';
+
+    addPropertyTo(this, 'role');
+}

package/src/theme.js

@@ -0,0 +1,188 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, serialise, create, fromJson, enumerateFiles, getOne,
+    patchOne, fromJsonList, getList } from './model.js';
+import { themeStatus } from './theme_status.js';
+import { MerchiFile } from './merchi_file.js';
+import { Component } from './component.js';
+import { Domain } from './domain.js';
+import { Page } from './page.js';
+import { User } from './user.js';
+import { InternalTag } from './internal_tag.js';
+
+export function Theme() {
+    this.resource = '/themes';
+    this.json = 'theme';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'aiContext');
+    addPropertyTo(this, 'jsBundle');
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'description');
+    addPropertyTo(this, 'foundation');
+    addPropertyTo(this, 'public');
+    addPropertyTo(this, 'lastUpdated');
+
+    addPropertyTo(this, 'components', Component);
+    addPropertyTo(this, 'contextComponents', Component);
+    addPropertyTo(this, 'featureImage', MerchiFile);
+    addPropertyTo(this, 'images', MerchiFile);
+    addPropertyTo(this, 'cssImageFiles', MerchiFile);
+    addPropertyTo(this, 'pages', Page);
+
+    addPropertyTo(this, 'headerTemplate');
+    addPropertyTo(this, 'headerHtml');
+    addPropertyTo(this, 'footerTemplate');
+    addPropertyTo(this, 'footerHtml');
+    addPropertyTo(this, 'indexPageTemplate');
+    addPropertyTo(this, 'indexHtml');
+    addPropertyTo(this, 'domainInvitePageTemplate');
+    addPropertyTo(this, 'domainInviteHtml');
+    addPropertyTo(this, 'resetPasswordPageTemplate');
+    addPropertyTo(this, 'passwordResetHtml');
+    addPropertyTo(this, 'passwordChangePageTemplate');
+    addPropertyTo(this, 'passwordChangeHtml');
+    addPropertyTo(this, 'jobDraftingPageTemplate');
+    addPropertyTo(this, 'jobDraftingHtml');
+    addPropertyTo(this, 'jobQuoteRequestedPageTemplate');
+    addPropertyTo(this, 'jobQuoteRequestedHtml');
+    addPropertyTo(this, 'draftPreviewPageTemplate');
+    addPropertyTo(this, 'draftPreviewHtml');
+    addPropertyTo(this, 'invoicePageTemplate');
+    addPropertyTo(this, 'invoiceHtml');
+    addPropertyTo(this, 'productPageTemplate');
+    addPropertyTo(this, 'productHtml');
+    addPropertyTo(this, 'invoicePaidPageTemplate');
+    addPropertyTo(this, 'invoicePaidHtml');
+    addPropertyTo(this, 'loginPageTemplate');
+    addPropertyTo(this, 'loginPageHtml');
+    addPropertyTo(this, 'errorPageTemplate');
+    addPropertyTo(this, 'errorPageHtml');
+
+    addPropertyTo(this, 'footerError');
+    addPropertyTo(this, 'headerError');
+    addPropertyTo(this, 'indexPageError');
+    addPropertyTo(this, 'productsPageError');
+    addPropertyTo(this, 'domainInvitePageError');
+    addPropertyTo(this, 'resetPasswordPageError');
+    addPropertyTo(this, 'passwordChangePageError');
+    addPropertyTo(this, 'jobDraftingPageError');
+    addPropertyTo(this, 'jobQuoteRequestedPageError');
+    addPropertyTo(this, 'invoicePageError');
+
+    addPropertyTo(this, 'productPageError');
+    addPropertyTo(this, 'invoicePaidPageError');
+    addPropertyTo(this, 'loginPageError');
+    addPropertyTo(this, 'errorPageError');
+
+    addPropertyTo(this, 'mainCssErrorMessage');
+    addPropertyTo(this, 'mainCssStatus');
+    addPropertyTo(this, 'mainCss');
+    addPropertyTo(this, 'mainCssTemplateEditing');
+    addPropertyTo(this, 'mainCssTemplateUsing');
+
+    addPropertyTo(this, 'emailCssErrorMessage');
+    addPropertyTo(this, 'emailCssStatus');
+    addPropertyTo(this, 'emailCss');
+    addPropertyTo(this, 'emailCssTemplateEditing');
+    addPropertyTo(this, 'emailCssTemplateUsing');
+
+    addPropertyTo(this, 'author', User);
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'defaultForDomainType');
+    addPropertyTo(this, 'internalTags', InternalTag);
+
+    this.create = function (success, error, embed, as_domain) {
+        var self = this,
+            data = serialise(this);
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: as_domain,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+     };
+
+    this.get = function (success, error, embed) {
+        var self = this;
+
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+
+        getOne({resource: this.resource,
+                id: this.id(),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+     };
+
+   this.patch = function (success, error, embed) {
+        var self = this,
+            data = serialise(this)[0];
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  data: data,
+                  embed: embed});
+    };
+
+    this.canBeActivated = function () {
+        var validStatus = themeStatus.get("VALID_BUT_NOT_UPDATED");
+        return this.mainCssStatus() >= validStatus &&
+            this.emailCssStatus() >= validStatus;
+    };
+
+    this.isActiveOnDomain = function (domainId) {
+        var domain = this.domain();
+        return domain && domain.id() === parseInt(domainId, 10) &&
+            domain.activeThemeId() === this.id();
+    };
+
+    this.getPageBySlug = function (slug) {
+        var pages = this.pages() ? this.pages() : [],
+            i;
+        for (i = 0; i < pages.length; i++) {
+            var page = pages[i];
+            if (page.slug() === slug) {
+                return page;
+             }
+        }
+         return null;
+     };
+
+    this.updateTemplateByName = function (name, text) {
+        var page = this.getPageBySlug(name);
+        if (page) {
+            page.template(text);
+        } else {
+            this[name](text);
+        }
+    };
+}
+
+export function Themes() {
+    this.resource = '/themes';
+    this.json = 'themes';
+    this.single = Theme;
+
+    this.get = function (success, error, parameters) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result,
+                                 {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error, parameters);
+    };
+
+}