@crmcom/self-service-sdk 2.1.2

package/organisations.js

@@ -0,0 +1,141 @@
+import { httpUtil } from './httpUtil'
+import { ErrorCodes, createResult, createCommonResult } from './resultUtil'
+import { logger } from './logger';
+
+export const organisations = {
+    searchOrganisations,
+    getLocations,
+    getOrganisation
+}
+
+async function searchOrganisations({
+    business_activities,
+    contact_registry,
+    countries,
+    custom_fields,
+    distance,
+    include_custom_fields,
+    include_order_catalogs,
+    include_total,
+    include_wifi_sites,
+    industries,
+    industry_sectors,
+    lat,
+    lon,
+    name,
+    tags,
+    tap_code,
+    town_cities,
+    type,
+    page = 1,
+    size = 20,
+    sort='name',
+    order='ASC',
+} = {}, orgId) {
+    try {
+        let queryParams = {
+            business_activities,
+            contact_registry,
+            countries,
+            custom_fields,
+            distance,
+            include_custom_fields,
+            include_order_catalogs,
+            include_total,
+            include_wifi_sites,
+            industries,
+            industry_sectors,
+            lat,
+            lon,
+            name,
+            tags,
+            tap_code,
+            town_cities,
+            type,
+            page,
+            size,
+            sort,
+            order
+        };
+        let id = orgId ? orgId : httpUtil.getSession().current_organisation_id;
+        let response = await httpUtil.get({
+            resourcePath: '/v2/organisations/' + id + '/network',
+            queryParams: queryParams,
+            withAccessToken: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception searchOrganisations:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function getLocations({
+    lat,
+    lon,
+    business_activities,
+    include_creatives,
+    include_opening_hours,
+    industries,
+    industry_sectors,
+    is_open,
+    name,
+    supply_method,
+    tags,
+    town_cities,
+    within,
+    page = 1,
+    size = 20,
+    sort='name',
+    order='ASC',
+    include_custom_fields = true,
+    custom_fields,
+    organisation_id
+} = {}) {
+    try {
+        let queryParams = {
+            lat,
+            lon,
+            business_activities,
+            include_creatives,
+            include_opening_hours,
+            industries,
+            industry_sectors,
+            is_open,
+            name,
+            supply_method,
+            tags,
+            town_cities,
+            within,
+            page,
+            size,
+            sort,
+            order,
+            include_custom_fields,
+            custom_fields,
+            organisation_id
+        };
+        let response = await httpUtil.get({
+            resourcePath: '/v2/locations',
+            queryParams: queryParams,
+            withAccessToken: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception getLocations:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function getOrganisation(id) {
+    try {
+        let response = await httpUtil.get({
+            resourcePath: '/v2/organisations/' + id,
+            withAccessToken: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception getOrganisation:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@crmcom/self-service-sdk",
+  "version": "2.1.2",
+  "description": "Official CRM.COM Self-Service JavaScript SDK for consumer-facing API integration",
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": "./index.js",
+    "./httpUtil": "./httpUtil.js",
+    "./httpBackOfficeUtil": "./httpBackOfficeUtil.js",
+    "./authentication": "./authentication.js",
+    "./contacts": "./contacts.js",
+    "./orders": "./orders.js",
+    "./wallet": "./wallet.js",
+    "./payment": "./payment.js",
+    "./subscriptions": "./subscriptions.js",
+    "./rewards": "./rewards.js",
+    "./account": "./account.js",
+    "./communications": "./communications.js",
+    "./community": "./community.js",
+    "./config": "./config.js",
+    "./connectx": "./connectx.js",
+    "./organisations": "./organisations.js",
+    "./servicerequest": "./servicerequest.js",
+    "./jcccards": "./jcccards.js",
+    "./mobilepass": "./mobilepass.js",
+    "./paymentgateway": "./paymentgateway.js",
+    "./payouts": "./payouts.js",
+    "./dataUtil": "./dataUtil.js",
+    "./resultUtil": "./resultUtil.js",
+    "./eventListener": "./eventListener.js",
+    "./logger": "./logger.js"
+  },
+  "files": [
+    "*.js",
+    "*.d.ts",
+    "!add_imports.ps1"
+  ],
+  "keywords": [
+    "crm",
+    "crm.com",
+    "sdk",
+    "api",
+    "loyalty",
+    "rewards",
+    "wallet",
+    "payments",
+    "orders",
+    "subscriptions"
+  ],
+  "author": "CRM.COM",
+  "license": "MIT",
+  "peerDependencies": {
+    "jwt-decode": ">=3.0.0",
+    "js-sha256": ">=0.9.0",
+    "xml2js": ">=0.4.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://bitbucket.org/nicostella/shared_libs_v2.git"
+  }
+}

package/payment.js

@@ -0,0 +1,338 @@
+import { httpUtil } from './httpUtil'
+import { ErrorCodes, createResult, createCommonResult } from './resultUtil'
+import { wallet } from './wallet';
+import { logger } from './logger';
+
+export const payment = {
+    getListPaymentMethods,
+    addPaymentMethod,
+    removePaymentMethod,
+    createPaymentForm,
+    createFormToAddCard,
+    setPrimaryCard,
+    addPaymentMethodV2,
+    getFormAddCard,
+    getPaymentForm,
+    createTopup,
+}
+
+async function getListPaymentMethods({
+    include_total,
+    page = 1,
+    size = 10,
+    sort,
+    order,
+    support_payouts,
+    financial_types,
+    is_rewards,
+} = {}) {
+    try {
+        let id = httpUtil.getSession().sub;
+        //console.log('API: ', contact)
+        let response = await httpUtil.get({
+            resourcePath: "/v2/contacts/" + id + "/payment_methods",
+            queryParams: {
+                include_total,
+                page,
+                size,
+                sort,
+                order,
+                support_payouts,
+                financial_types,
+                is_rewards,
+            },
+            withAccessToken: true,
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception getContactPurchases:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function addPaymentMethod({
+    name,
+    contact_id,
+    is_primary,
+    is_backup,
+    payment_method_type,
+    notes,
+    email,
+    phone,
+    country_code,
+    card_info,
+    gateway_name,
+    gateway_token,
+    integration_id
+}, { }) {
+    try {
+        let id = httpUtil.getSession().sub;
+        let wallet = null;
+        let card = null;
+        if (payment_method_type == 'WALLET') {
+            wallet = {
+                gateway_token: [{
+                    gateway: gateway_name ? gateway_name : null,
+                    integration_id: integration_id,
+                    token: gateway_token
+                }]
+            }
+            if (email) {
+                wallet.email = email;
+            }
+            if (phone) {
+                wallet.phone_details = {
+                    number: phone,
+                    country_code: country_code
+                }
+            }
+        }
+        if (payment_method_type == 'CARD') {
+            card = {
+                ...card_info,
+                gateway_token: [{
+                    integration_id: integration_id,
+                    token: gateway_token,
+                    gateway: gateway_name,
+                }]
+            }
+        }
+        let response = await httpUtil.post({
+            resourcePath: "/v2/contacts/" + id + "/payment_methods",
+            body: {
+                name,
+                contact_id,
+                payment_method_type,
+                is_primary,
+                is_backup,
+                notes,
+                wallet,
+                card
+            },
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception addPaymentMethod:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function addPaymentMethodV2({
+    name,
+    is_primary,
+    payment_method_type,
+    account_debit,
+    wallet,
+    card,
+    contact_id,
+}) {
+    try {
+        let id = httpUtil.getSession().sub;
+        if (!contact_id) contact_id = id;
+        let response = await httpUtil.post({
+            resourcePath: "/v2/contacts/" + id + "/payment_methods",
+            body: {
+                name,
+                is_primary,
+                payment_method_type,
+                account_debit,
+                wallet,
+                card,
+                contact_id,
+            },
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception addPaymentMethodV2:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function removePaymentMethod(paymentMethodId) {
+    try {
+        let id = httpUtil.getSession().sub;
+        let response = await httpUtil.sendDelete({
+            resourcePath: '/v2/contacts/' + id + '/payment_methods/' + paymentMethodId,
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception removePaymentMethod:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function createPaymentForm({
+    topup_amount,
+    payment_method_id,
+    redirect_url,
+    estimation_id,
+}) {
+    try {
+        let response = await httpUtil.get({
+            resourcePath: '/v2/jcc/payment_form',
+            withAccessToken: true,
+            queryParams: {
+                topup_amount,
+                payment_method_id,
+                redirect_url,
+                estimation_id
+            },
+            returnText: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception createPaymentFormTopup:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function createFormToAddCard(redirect_url) {
+    let plus_path = "";
+    if (redirect_url) {
+        plus_path = "&redirect_url=" + redirect_url
+    }
+    try {
+        let response = await httpUtil.get({
+            resourcePath: "/v1/jcc/form?action=CREATE" + plus_path,
+            withAccessToken: true,
+            returnText: true,
+        });
+
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception createFormToAddCard:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function setPrimaryCard(payment_method_id) {
+    try {
+        let id = httpUtil.getSession().sub;
+        let response = await httpUtil.put({
+            // resourcePath: "/v2/contacts/" + id + "/payment_methods/" + payment_method_id,
+            resourcePath: "/v1/contacts/" + id + "/payment_methods/" + payment_method_id,
+            body: {
+                is_primary: true
+            },
+            withAccessToken: true,
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception setPrimaryCard:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function getFormAddCard({
+    integration_id,
+    device_type,
+    redirect_url,
+    currency_code,
+    back_url,
+    back_url_name
+}) {
+    try {
+        let response = await httpUtil.get({
+            resourcePath: '/v2/hosted_pages/payment_methods',
+            withAccessToken: true,
+            queryParams: {
+                integration_id,
+                device_type,
+                redirect_url,
+                currency_code,
+                back_url,
+                back_url_name
+            },
+            returnText: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception getFormAddCard:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function getPaymentForm({
+    integration_id,
+    device_type,
+    redirect_url,
+    currency_code,
+    amount,
+    estimation_id,
+    payment_method_id,
+    type,
+    header_accept,
+    header_accept_language,
+    browser_color_depth,
+    browser_screen_height,
+    browser_screen_width,
+    browser_java_enabled,
+    time_zone_offset,
+    user_agent,
+    back_url,
+    back_url_name
+}) {
+    try {
+        let response = await httpUtil.get({
+            resourcePath: '/v2/hosted_pages/payments',
+            withAccessToken: true,
+            queryParams: {
+                integration_id,
+                device_type,
+                redirect_url,
+                currency_code,
+                amount,
+                estimation_id,
+                payment_method_id,
+                type,
+                header_accept,
+                header_accept_language,
+                browser_color_depth,
+                browser_screen_height,
+                browser_screen_width,
+                browser_java_enabled,
+                time_zone_offset,
+                user_agent,
+                back_url,
+                back_url_name
+            },
+            returnText: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception getPaymentForm:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}
+
+async function createTopup({
+    amount,
+    wallet_id,
+    code,
+    payment_method,
+    client_secret,
+    commerce_pool_id,
+}) {
+    try {
+        if(!wallet_id) {
+            wallet_id = await wallet.getWalletId();
+        }
+        let response = await httpUtil.post({
+            resourcePath: '/v2/topups',
+            withAccessToken: true,
+            body: {
+                amount: amount,
+                wallet_id,
+                code,
+                payment_method,
+                client_secret,
+                commerce_pool_id,
+            },
+            returnText: true
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error('Exception createTopup:', e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}

package/paymentgateway.js

@@ -0,0 +1,26 @@
+import { httpUtil } from './httpUtil'
+import { ErrorCodes, createResult, createCommonResult } from './resultUtil'
+import { logger } from './logger';
+
+export const paymentgateway = {
+    getClientToken,
+}
+
+async function getClientToken({
+    integration_id
+} = {}) {
+    try {
+        let id = httpUtil.getSession().sub;
+        let response = await httpUtil.get({
+            resourcePath: "/v2/contacts/" + id + "/client_token",
+            queryParams: {
+                integration_id,
+            },
+            withAccessToken: true,
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception getClientToken:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}

package/payouts.js

@@ -0,0 +1,33 @@
+import { httpUtil } from './httpUtil'
+import { ErrorCodes, createResult, createCommonResult } from './resultUtil'
+import { wallet } from './wallet'
+import { logger } from './logger';
+
+export const payouts = {
+    createPayout,
+}
+
+async function createPayout({
+    wallet_id,
+    amount,
+    payment_method,
+}) {
+    try {
+        if (!wallet_id) {
+            wallet_id = await wallet.getWalletId();
+        }
+        let response = await httpUtil.post({
+            resourcePath: "/v2/payouts",
+            body: {
+                wallet_id,
+                amount,
+                payment_method,
+            },
+            withAccessToken: true,
+        });
+        return createCommonResult(response);
+    } catch (e) {
+        logger.error("Exception createPayout:", e);
+        return createResult(ErrorCodes.UNKNOWN, e);
+    }
+}

package/resultUtil.js

@@ -0,0 +1,86 @@
+import { logger } from './logger';
+
+
+export const ErrorCodes = {
+	OK: 'OK',
+	UNKNOWN: 'UNKNOWN',
+	UNCLASSIFIED_ERROR: 'UNCLASSIFIED_ERROR',
+	REGISTRATION_FAIL_CONTACT_EXISTS: 'REGISTRATION_FAIL_CONTACT_EXISTS',
+	INVALID_LOGIN: 'INVALID_LOGIN',
+	ACCOUNT_NOT_FOUND: 'ACCOUNT_NOT_FOUND',
+	ADD_ADDRESS_ALREADY_TYPE: 'ADD_ADDRESS_ALREADY_TYPE',
+	FORGOT_EMAIL_NOT_FOUND_EXCEPTION: 'FORGOT_EMAIL_NOT_FOUND_EXCEPTION',
+	PHONE_NUMBER_ALREADY_EXIST: 'PHONE_NUMBER_ALREADY_EXIST',
+	CAN_NOT_FULFILL_ORDER_EXCEPTION: 'CAN_NOT_FULFILL_ORDER_EXCEPTION',
+	MINIMUM_ORDER_AMOUNT_NOT_REACHED: 'MINIMUM_ORDER_AMOUNT_NOT_REACHED',
+	SIGN_UP_ORGANISATION_ALREADY: 'SIGN_UP_ORGANISATION_ALREADY',
+	CONTACTUNIQUELYIDENTIFYEXCEPTION: 'CONTACTUNIQUELYIDENTIFYEXCEPTION',
+	NOTFOUNDEXCEPTION: 'NOTFOUNDEXCEPTION',
+	EMAIL_NOT_VERIFIED: 'EMAIL_NOT_VERIFIED',
+	CARD_ALREADY_EXIT: 'CARD_ALREADY_EXIT',
+	CARD_NOT_FOUND: 'CARD_NOT_FOUND',
+	INVALID_PASSWORD_EXCEPTION: 'INVALID_PASSWORD_EXCEPTION',
+	PASSWORD_LENGTH_EXCEPTION: 'PASSWORD_LENGTH_EXCEPTION',
+	PAYMENT_GATEWAY_EXCEPTION: 'PAYMENT_GATEWAY_EXCEPTION',
+	CUSTOMER_EMAIL_ALREADY_EXIST: 'CUSTOMER_EMAIL_ALREADY_EXIST',
+	TOO_MANY_REQUESTS: "TOO_MANY_REQUESTS",
+	TOO_MANY_RECIPIENTS_EXCEPTION: "TOO_MANY_RECIPIENTS_EXCEPTION",
+	SPEND_AMOUNT_NOT_FULLY_COVERED_EXCEPTION: 'SPEND_AMOUNT_NOT_FULLY_COVERED_EXCEPTION',
+	REDEEM_PASS_INVALID: "REDEEM_PASS_INVALID",
+	REDEEM_PASS_NOT_ACTIVE: "REDEEM_PASS_NOT_ACTIVE",
+	REDEEM_PASS_PIN_MANDATORY: "REDEEM_PASS_PIN_MANDATORY",
+	REDEEM_PASS_USED: "REDEEM_PASS_USED",
+	SERVICE_ALREADY_EXIST: "SERVICE_ALREADY_EXIST",
+	CANNOTEXECUTEACTIONCREDITLIMITEXCEPTION: 'CANNOTEXECUTEACTIONCREDITLIMITEXCEPTION',
+	CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION: 'CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION',
+	CANNOTUNREGISTERCONTACTEXCEPTION: 'CANNOTUNREGISTERCONTACTEXCEPTION',
+	CANNOTEXECUTESUBSCRIPTIONACTIONEXCEPTION: 'CANNOTEXECUTESUBSCRIPTIONACTIONEXCEPTION',
+	INVALIDVALUEEXCEPTION: "INVALIDVALUEEXCEPTION",
+	MULTIPLECONTACTSSAMEPHONEEXCEPTION: "MULTIPLECONTACTSSAMEPHONEEXCEPTION",
+	COMMUNITYPARENTCHILDEXCEPTION: "COMMUNITYPARENTCHILDEXCEPTION",
+	CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION: "CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION",
+	INVALIDENTITYLIFECYCLESTATEEXCEPTION: "INVALIDENTITYLIFECYCLESTATEEXCEPTION"
+}
+
+export function createResult(errorCode, data) {
+	return {
+		code: errorCode,
+		data: data
+	}
+}
+
+export function createCommonResult(response, requestType) {
+	logger.debug("createCommonResult response:", response);
+	if (response.code == 'OK' || response.code == '204')
+		return createResult(ErrorCodes.OK, response.data);
+	else if (response.code == '429') {
+		return createResult(ErrorCodes.TOO_MANY_REQUESTS, response.error);
+	} else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.SPENDAMOUNTNOTFULLYCOVEREDEXCEPTION") {
+		return createResult(ErrorCodes.SPEND_AMOUNT_NOT_FULLY_COVERED_EXCEPTION, response.error);
+	} else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.CANNOTUNREGISTERCONTACTEXCEPTION") {
+		return createResult(ErrorCodes.CANNOTUNREGISTERCONTACTEXCEPTION, response.error)
+	} else if (response.error && response.error.error == "CRM.EXCEPTIONS.INVALIDVALUEEXCEPTION") {
+		return createResult(ErrorCodes.INVALIDVALUEEXCEPTION, response.error)
+	} else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.CONTACTUNIQUELYIDENTIFYEXCEPTION") {
+		return createResult(ErrorCodes.CONTACTUNIQUELYIDENTIFYEXCEPTION, response.error)
+	} else if (response.error && response.error.error == "CRM.EXCEPTIONS.ALREADYEXISTSEXCEPTION") {
+		return createResult(ErrorCodes.CUSTOMER_EMAIL_ALREADY_EXIST, response.error)
+	} else if (response.error && response.error.error == "CRM.EXCEPTIONS.CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION") {
+		return createResult(ErrorCodes.CANNOTSPENDAMOUNTWALLETBALANCENOTENOUGHEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "CRM.EXCEPTIONS.NOTFOUNDEXCEPTION") {
+		return createResult(ErrorCodes.NOTFOUNDEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.MULTIPLECONTACTSSAMEPHONEEXCEPTION") {
+		return createResult(ErrorCodes.MULTIPLECONTACTSSAMEPHONEEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.COMMUNITYPARENTCHILDEXCEPTION") {
+		return createResult(ErrorCodes.COMMUNITYPARENTCHILDEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION") {
+		return createResult(ErrorCodes.CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "COM.CRM.EXCEPTIONS.CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION") {
+		return createResult(ErrorCodes.CIMALREADYEXISTSFORANOTHERCONTACTEXCEPTION, response.error)
+	}else if (response.error && response.error.error == "CRM.EXCEPTIONS.INVALIDENTITYLIFECYCLESTATEEXCEPTION") {
+		return createResult(ErrorCodes.INVALIDENTITYLIFECYCLESTATEEXCEPTION, response.error)
+	}
+	else {
+		return createResult(ErrorCodes.UNCLASSIFIED_ERROR, response.error);
+	}
+}