loyalme v1.1.5

Loyalme

Loyalme module that allows you to communicate with the Loyalme API from node.js

Installation

npm install loyalme

Usage

// Import a module
import Loyalme from 'loyalme';
// Create an instance with your API credentials
const loyalme = Loyalme({
  url: 'loyaltycrm.ru/api',
  token: 'token',
  brandId: 1,
  pointId: 2,
  personId: 3
});

loyalme.client

loyalme.client({
  externalId: '12345',
  email: 'user@email.com',
  phone: '1111111111',
  name: 'User',
  lastName: 'Userlastname',
  birthdate: '2000-01-03'
}).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.clientFingerprint

loyalme.clientFingerprint({
  id: 12345,
  fingerprint: 'abcdefg'
}).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.product

loyalme.product([{
  title: 'ProductName',
  extItemId: 123456
}], [{
  name: 'CategoryName',
  externalId: '123456'
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.category

loyalme.category([{
  name: 'CategoryName1',
  externalId: '123456'
}, {
  name: 'CategoryName2',
  externalId: '1234567'
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.activityList

loyalme.activityList()
.then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.cancelEvent

loyalme.cancelEvent({
  clientId: 123,
  clientHash: '1a42949f6c7d805112543a98203bac42',
  activityKey: 'ordercreated'
})
.then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.fireEvent

loyalme.fireEvent({
  clientId: 123,
  clientHash: '1a42949f6c7d805112543a98203bac42',
  activityKey: 'ordercreated',
  activityCreatedAt: '2020-01-15 12:01:05'
})
.then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.deliveryMethod

loyalme.deliveryMethod([{
  title_en: 'MethodName1',
  slug: 'name1',
  is_active: 1
}, {
  title_en: 'MathodName2',
  title_ru: 'ИмяМетода',
  slug: 'name2',
  is_active: 1
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.order

loyalme.order([{
  status: 'new',
  extOrderId: '123',
  amount: '10.00',
  products: [{
    quantity: 1,
    product_id: 2,
    price: '10.00'
  }]
}, {
  status: 'new',
  extOrderId: '12345',
  amount: '10.00',
  products: [{
    quantity: 1,
    product_id: 2,
    price: '10.00'
  }]
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.orderStatus

loyalme.orderStatus([{
  title_en: 'StatusName1',
  slug: 'name1',
  is_active: 1
}, {
  title_en: 'StatusName2',
  title_ru: 'ИмяСтатуса',
  slug: 'name2',
  is_active: 1
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.paymentMethod

loyalme.paymentMethod([{
  title_en: 'MethodName1',
  slug: 'name1',
  is_active: 1
}, {
  title_en: 'MathodName2',
  title_ru: 'ИмяМетода',
  slug: 'name2',
  is_active: 1
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.paymentStatus

loyalme.paymentStatus([{
  title_en: 'StatusName1',
  slug: 'name1',
  is_active: 1
}, {
  title_en: 'StatusName2',
  title_ru: 'ИмяСтатуса',
  slug: 'name2',
  is_active: 1
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});

loyalme.promocode

loyalme.promocode([{
  code: '123',
  activeFrom: '2021-01-01 12:01:30',
  activeTo: '2021-01-14 18:11:35',
  status: 'is_active',
  description: 'content'
}]).then(output => {
  console.info(output);
}).catch(err => {
  console.error(err);
});