merchi_sdk_js 0.0.1

package/src/address.js

@@ -0,0 +1,107 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson, getOne, fromJsonList,
+    Request } from './model.js'
+import { isUndefinedOrNull } from './helpers.js';
+import { Dictionary } from './dictionary.js';
+
+export function Address() {
+    this.resource = '/addresses';
+    this.json = 'address';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'lineOne');
+    addPropertyTo(this, 'lineTwo');
+    addPropertyTo(this, 'city');
+    addPropertyTo(this, 'state');
+    addPropertyTo(this, 'country');
+    addPropertyTo(this, 'postcode');
+
+    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.fullAddressString = function () {
+        var self = this, a = '', space = ' ', noSpace = '';
+        function attributeHasValue(attr, before, after) {
+            var value = self[attr]();
+            return !isUndefinedOrNull(value) ? before + value + after : '';
+        }
+        a = attributeHasValue('lineOne', noSpace, noSpace);
+        a += attributeHasValue('lineTwo', space, ',');
+        a += attributeHasValue('city', space, space);
+        a += attributeHasValue('state', noSpace, space);
+        a += attributeHasValue('postcode', noSpace, space);
+        a += attributeHasValue('country', noSpace, noSpace);
+        return a;
+    };
+
+    this.stateAndCountryString = function () {
+        var addressString = '';
+        addressString += this.state() + " ";
+        addressString += this.country();
+        return addressString;
+    };
+
+    this.cityStateCountryPostcode = function () {
+        return this.city() + " " + this.stateAndCountryString() +
+            ", " + this.postcode();
+    }
+
+    this.isValid = function () {
+        return Boolean(this.lineOne() && this.city() &&
+            this.state() && this.country());
+    }
+}
+
+
+export function Addresses() {
+    this.resource = '/addresses';
+    this.json = 'addresses';
+    this.single = Address;
+
+    this.getRelated = function (options) {
+        var request = new Request(),
+            query = new Dictionary(),
+            self = this,
+            success = options.success,
+            error = options.error,
+            userId = options.userId,
+            companyId = options.companyId,
+            jobId = options.jobId;
+        if (userId) {
+            query.add('user_id', userId);
+        }
+        if (companyId) {
+            query.add('company_id', companyId);
+        }
+        if (jobId) {
+            query.add('job_id', jobId);
+        }
+        request.resource('/related-addresses/');
+        request.method('GET');
+        request.query().merge(query);
+        function handleResponse(status, data) {
+            if (status === 200) {
+                success(fromJsonList(self, data));
+           } else {
+                error(data);
+            }
+        }
+        function handleError(status, data) {
+            var responseData = data ? data :
+                {message: 'could not connect to server',
+                   errorCode: 0}
+            error(status, responseData);
+        }
+        request.responseHandler(handleResponse).errorHandler(handleError);
+        request.send();
+    };
+}

package/src/assignment.js

@@ -0,0 +1,165 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, fromJson, create, serialise, enumerateFiles, getList,
+    patchOne, fromJsonList, getOne } from './model.js';
+import { notificationTypes, notificationRecieverIsCurrentUserFilter,
+   notificationsFilter } from './notification_types.js';
+import { Job } from './job.js';
+import { User } from './user.js';
+import { Notification } from './notification.js';
+import { Quote } from './quote.js';
+import { Shipment } from './shipment.js';
+import { SupplyDomain } from './supply_domain.js';
+import { ProductionComment } from './production_comment.js';
+
+export function Assignment() {
+    this.resource = '/assignments';
+    this.json = 'assignment';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'managerAccepts');
+    addPropertyTo(this, 'supplierRefused');
+    addPropertyTo(this, 'productionDeadline');
+    addPropertyTo(this, 'assignmentDeadline');
+    addPropertyTo(this, 'needsDrafting');
+    addPropertyTo(this, 'needsShipping');
+    addPropertyTo(this, 'archived');
+    addPropertyTo(this, 'job', Job);
+    addPropertyTo(this, 'supplyJob', Job);
+    addPropertyTo(this, 'supplier', User);
+    addPropertyTo(this, 'quote', Quote);
+    addPropertyTo(this, 'shipment', Shipment);
+    addPropertyTo(this, 'supplyDomain', SupplyDomain);
+    addPropertyTo(this, 'comments', ProductionComment);
+    addPropertyTo(this, 'notifications', Notification);
+
+    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.agreedDeadline = function () {
+        var self = this,
+            quote = self.quote();
+        if (Boolean(quote)) {
+            return quote.agreedDeadline();
+        }
+        return null;
+    };
+
+    this.create = function (success, error, embed, asDomainId) {
+        var data = serialise(this),
+            self = this;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                 as_domain: asDomainId,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+    };
+
+    this.patch = function (success, error, embed, asDomain) {
+        var self = this,
+            data = serialise(this, undefined, undefined, undefined,
+                             {excludeOld: true})[0],
+            domainId = Boolean(asDomain) ? asDomain.id() : null;
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        patchOne({resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  as_domain: domainId,
+                  data: data,
+                  embed: embed});
+      };
+
+      this.setManagerAccepts = function () {
+        var acceptDate = Date.now();
+        this.managerAccepts(acceptDate / 1000);
+    };
+
+    this.agreedDeadline = function () {
+        var self = this,
+            quote = self.quote();
+        if (Boolean(quote) && Boolean(quote.agreedDeadline())) {
+            return quote.agreedDeadline();
+        }
+        return null;
+    };
+     this.unseenNotifications = function (currentUser) {
+        var notifications =
+            notificationRecieverIsCurrentUserFilter(currentUser,
+                                                    this.notifications());
+        return notificationsFilter(notifications, [{'seen': false}]);
+    };
+
+    this.unseenNotificationCount = function (currentUser) {
+        return this.unseenNotifications(currentUser).length;
+    };
+
+    this.unseenCommentNotifications = function (currentUser) {
+        var noteType = notificationTypes.get('PRODUCTION_COMMENT'),
+            notifications = this.unseenNotifications(currentUser);
+        return notificationsFilter(notifications,
+            [{'notificationType': noteType}]);
+    };
+
+    this.unseenCommentNotificationsCount = function (currentUser) {
+        return this.unseenCommentNotifications(currentUser).length;
+    };
+
+    this.unseenQuoteNotifications = function (currentUser) {
+        var approved = notificationTypes.get('QUOTE_APPROVED'),
+            supplierRefused = notificationTypes.get('SUPPLIER_REFUSED'),
+            refused = notificationTypes.get('QUOTE_REFUSED'),
+            submitted = notificationTypes.get('QUOTE_SUBMITTED'),
+            failed = notificationTypes.get('QUOTE_FAILED'),
+            commenced = notificationTypes.get('QUOTE_COMMENCED'),
+            expired = notificationTypes.get('QUOTE_EXPIRED'),
+            notifications = this.unseenNotifications(currentUser);
+        return notificationsFilter(notifications,
+            [{'notificationType': approved}, {'notificationType': refused},
+             {'notificationType': submitted}, {'notificationType': failed},
+             {'notificationType': commenced}, {'notificationType': expired},
+             {'notificationType': supplierRefused}]);
+    };
+
+    this.isUserSupplier = function (user) {
+        var self = this;
+        if (Boolean(self.supplier()) &&
+            self.supplier().id() === user.id()) {
+            return true;
+        }
+        return false;
+    };
+}
+
+export function Assignments() {
+    this.resource = '/assignments';
+    this.json = 'assignments';
+    this.single = Assignment;
+
+    this.get = function (success, error, parameters, withUpdates) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+          parameters, withUpdates);
+    };
+}

package/src/automatic_payment_relationship.js

@@ -0,0 +1,65 @@
+import { Company } from './company.js';
+import { generateUUID } from './uuid.js';
+import {
+    addPropertyTo, serialise, fromJson, create, enumerateFiles,
+    deleteOne, getList, fromJsonList, getOne } from './model.js';
+
+export function AutomaticPaymentRelationship() {
+    this.resource = '/automatic_payment_relationships';
+    this.json = 'automaticPaymentRelationship';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'archived');
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'creationDate');
+    addPropertyTo(this, 'stripeCustomerId');
+    addPropertyTo(this, 'companyCustomer', Company);
+    addPropertyTo(this, 'companySupplier', Company);
+
+    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});
+    };
+
+    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.destroy = function (success, error) {
+        deleteOne(this.resource + "/" + this.id(), success, error);
+    };
+
+}
+
+export function AutomaticPaymentRelationships() {
+    this.resource = '/automatic_payment_relationships';
+    this.json = 'automaticPaymentRelationships';
+    this.single = AutomaticPaymentRelationship;
+
+    this.get = function (success, error, offset, limit, q) {
+        var self = this;
+        function handleResponse(result) {
+            success(fromJsonList(self, result, {makesDirty: false}));
+        }
+        getList(this.resource, handleResponse, error,
+                {offset: offset, limit: limit, q: q});
+    };
+}

package/src/backup.js

@@ -0,0 +1,29 @@
+import { addPropertyTo, deleteOne, fromJsonList, getList } from './model.js'
+import { MerchiFile } from './merchi_file.js';
+
+export function Backup() {
+    this.resource = '/backups';
+    this.json = 'backup';
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'file', MerchiFile);
+
+    this.destroy = function (success, error) {
+        deleteOne(this.resource + "/" + this.id(), success, error);
+    };
+}
+
+export function Backups() {
+    this.resource = '/backups';
+    this.json = 'backups';
+    this.single = Backup;
+
+    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/bank.js

@@ -0,0 +1,21 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo } from './model.js';
+import { Address } from './address.js';
+import { Companies } from './company.js';
+
+export function Bank() {
+    this.resource = '/banks';
+    this.json = 'bank';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'bankName');
+    addPropertyTo(this, 'accountNumber');
+    addPropertyTo(this, 'accountName');
+    addPropertyTo(this, 'bsb');
+    addPropertyTo(this, 'swiftCode');
+    addPropertyTo(this, 'iban');
+    addPropertyTo(this, 'bankCode');
+    addPropertyTo(this, 'bankAddress', Address);
+    addPropertyTo(this, 'company', Companies);
+}

package/src/cart.js

@@ -0,0 +1,131 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, serialise, enumerateFiles, getOne, fromJson, patchOne,
+   create } from './model.js';
+import { Address } from './address.js';
+import { CartItem } from './cart_item.js';
+import { CartShipmentGroup } from './cart_shipment_group.js';
+import { Company } from './company.js';
+import { Domain } from './domain.js';
+import { Invoice } from './invoice.js';
+import { Shipment } from './shipment.js';
+import { User } from './user.js';
+
+
+export function Cart() {
+    this.resource = '/carts';
+    this.json = 'cart';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'token');
+    addPropertyTo(this, 'ip');
+    addPropertyTo(this, 'client', User);
+    addPropertyTo(this, 'clientCompany', Company);
+    addPropertyTo(this, 'creationDate');
+    addPropertyTo(this, 'domain', Domain);
+    addPropertyTo(this, 'subtotalCost');
+    addPropertyTo(this, 'taxAmount');
+    addPropertyTo(this, 'totalCost');
+    addPropertyTo(this, 'cartItems', CartItem);
+    addPropertyTo(this, 'cartItemsSubtotalCost');
+    addPropertyTo(this, 'cartItemsTaxAmount');
+    addPropertyTo(this, 'cartItemsTotalCost');
+    addPropertyTo(this, 'shipmentSubtotalCost');
+    addPropertyTo(this, 'shipmentTaxAmount');
+    addPropertyTo(this, 'shipmentTotalCost');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'receiverNotes');
+    addPropertyTo(this, 'shipmentGroups', CartShipmentGroup);
+    addPropertyTo(this, 'invoice', Invoice);
+    addPropertyTo(this, 'shipment', Shipment);
+    addPropertyTo(this, 'receiverAddress', Address);
+
+    this.create = function (success, error, embed, asDomain) {
+        var self = this,
+            data = serialise(self);
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: asDomain,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+    };
+
+    this.get = function (success, error, embed, includeArchived,
+                         withRights) {
+        var self = this,
+            parameters = {
+                cartToken: this.token(),
+                embed: embed,
+                error: error,
+                id: this.id(),
+                includeArchived: includeArchived,
+                withRights: withRights,
+                resource: this.resource};
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json],
+                             {makesDirty: false}));
+        }
+        parameters.success = handleResponse;
+        getOne(parameters);
+    };
+
+    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({cartToken: this.token(),
+                  resource: this.resource,
+                  id: this.id(),
+                  success: handleResponse,
+                  error: error,
+                  data: data,
+                  embed: embed});
+    };
+
+    this.getShipmentGroupsAndQuotes = function (success, error) {
+        var self = this,
+            request = new Request();
+        request.resource(`/generate-cart-shipment-quotes/${self.id()}/`);
+        request.method('GET');
+        request.query().add('cart_token', this.token());
+        function handleResponse(status, data) {
+            if (status === 200) {
+                success(fromJson(self, data, {makesDirty: false}));
+            } else {
+                error(status, data);
+            }
+        }
+        request.responseHandler(handleResponse).errorHandler(error);
+        request.send();
+    };
+
+    this.requiresShipment = function () {
+        var cartItems = this.cartItems() ? this.cartItems() : [],
+            i;
+        for (i = 0; i < cartItems.length; i++) {
+            if (cartItems[i].requiresShipment()) {
+                return true;
+            }
+        }
+    };
+
+    this.stripePublishableKey = function () {
+        return this.domain().company() ?
+            this.domain().company().stripePublishableKey() : null;
+    };
+
+    this.stripeIsValidAndActive = function () {
+        const company = this.domain().company();
+        return this.stripePublishableKey() && company &&
+            company.acceptStripe();
+    };
+}

package/src/cart_item.js

@@ -0,0 +1,71 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo, serialise, fromJson, create,
+     enumerateFiles } from './model.js';
+import { Cart } from './cart.js';
+import { CountryTax } from './country_tax.js';
+import { Product } from './product.js';
+import { Variation } from './variation.js';
+import { VariationsGroup } from './variations_group.js';
+
+export function CartItem() {
+    this.resource = '/cart_items';
+    this.json = 'cartItem';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'creationDate');
+    addPropertyTo(this, 'cart', Cart);
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'quantity');
+    addPropertyTo(this, 'currency');
+    addPropertyTo(this, 'product', Product);
+    addPropertyTo(this, 'variations', Variation);
+    addPropertyTo(this, 'variationsGroups', VariationsGroup);
+    addPropertyTo(this, 'taxType', CountryTax);
+    addPropertyTo(this, 'subtotalCost');
+    addPropertyTo(this, 'totalCost');
+
+    this.hasVariationsGroups = function () {
+        var groups = this.variationsGroups();
+        return groups && groups.length > 0;
+    };
+
+    this.create = function (success, error, embed, asDomain) {
+        var self = this,
+            data = serialise(self);
+        function handleResponse(result) {
+            success(fromJson(self, result[self.json]));
+        }
+        create({resource: this.resource,
+                parameters: data[0],
+                as_domain: asDomain,
+                files: enumerateFiles(data[1]),
+                success: handleResponse,
+                error: error,
+                embed: embed});
+    };
+
+    this.calculate = function (success, error, embed) {
+        var request = new Request(),
+            data = serialise(this)[0];
+        request.resource('/cart-item-cost-estimate/');
+        request.method('POST');
+        request.query().add('skip_rights', true);
+        request.data().merge(data);
+        function handleResponse(status, data) {
+            if (status === 201) {
+                success(fromJson(new CartItem(), data));
+            } else {
+                error(data);
+            }
+        }
+        request.responseHandler(handleResponse).errorHandler(error);
+        request.send();
+    };
+
+    this.requiresShipment = function() {
+        var product = this.product();
+        return product ? product.needsShipping() : false;
+    };
+
+}

package/src/cart_shipment_group.js

@@ -0,0 +1,20 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo } from './model.js';
+import { CartItem } from './cart_item.js';
+import { CartShipmentQuote } from './cart_shipment_quote.js';
+
+export function CartShipmentGroup() {
+    this.resource = '/cart_shipment_groups';
+    this.json = 'cartShipmentGroup';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'cartItems', CartItem);
+    addPropertyTo(this, 'quotes', CartShipmentQuote);
+    addPropertyTo(this, 'selectedQuote', CartShipmentQuote);
+
+    this.selectedQuoteName = function () {
+        var selectedQuote = this.selectedQuote();
+        return selectedQuote ? selectedQuote.name() : null;
+    }
+}

package/src/cart_shipment_quote.js

@@ -0,0 +1,23 @@
+import { generateUUID } from './uuid.js';
+import { addPropertyTo } from './model.js';
+import { ShipmentMethod } from './shipment_method.js';
+
+export function CartShipmentQuote() {
+    this.resource = '/cart_shipment_quotes';
+    this.json = 'cartShipmentQuote';
+    this.temporaryId = generateUUID();
+
+    addPropertyTo(this, 'id');
+    addPropertyTo(this, 'name');
+    addPropertyTo(this, 'subtotalCost');
+    addPropertyTo(this, 'taxAmount');
+    addPropertyTo(this, 'totalCost');
+    addPropertyTo(this, 'shipmentMethod', ShipmentMethod);
+    addPropertyTo(this, 'shipmentServiceQuote')
+    addPropertyTo(this, 'shipmentService')
+
+    this.name = function () {
+        const shipmentMethod = this.shipmentMethod();
+        return shipmentMethod ? shipmentMethod.name() : null;
+    }
+}