@foxtware/mineral 0.1.0 → 0.1.1

package/api/logiwa/logiwaReportGetAvailableToPromise.js

@@ -0,0 +1,179 @@
+// https://myapi.logiwa.com/swagger/index.html#/Report/get_v3_1_Report_AvailableToPromise_i__index__s__size_
+
+const { ArgsWarden, actionSingleOrMultiple } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { DEFAULT_API_VERSION, MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const isSet = (value) => {
+  if (value === 0 || value === false || value === '') {
+    return true;
+  }
+
+  return Boolean(value);
+};
+
+const logiwaReportGetAvailableToPromiseSingle = async (
+  credsPayload,
+  {
+    apiVersion = DEFAULT_API_VERSION,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    sku_eq,
+    clientIdentifier_eq,
+    clientIdentifier_in,
+    warehouseIdentifier_eq,
+    warehouseIdentifier_in,
+    plannedAtpQuantity_eq,
+    plannedAtpQuantity_gt,
+    plannedAtpQuantity_lt,
+    plannedAtpQuantity_gte,
+    plannedAtpQuantity_lte,
+    totalStockQuantity_eq,
+    totalStockQuantity_gt,
+    totalStockQuantity_lt,
+    totalStockQuantity_gte,
+    totalStockQuantity_lte,
+    inventoryAtpQuantity_eq,
+    inventoryAtpQuantity_gt,
+    inventoryAtpQuantity_lt,
+    inventoryAtpQuantity_gte,
+    inventoryAtpQuantity_lte,
+    undamagedQuantity_eq,
+    undamagedQuantity_gt,
+    undamagedQuantity_lt,
+    undamagedQuantity_gte,
+    undamagedQuantity_lte,
+    currentAtpQuantity_eq,
+    currentAtpQuantity_gt,
+    currentAtpQuantity_lt,
+    currentAtpQuantity_gte,
+    currentAtpQuantity_lte,
+  } = {},
+) => {
+
+  const params = {
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(clientIdentifier_in && { 'ClientIdentifier.in': clientIdentifier_in }),
+    ...(warehouseIdentifier_eq && { 'WarehouseIdentifier.eq': warehouseIdentifier_eq }),
+    ...(warehouseIdentifier_in && { 'WarehouseIdentifier.in': warehouseIdentifier_in }),
+    ...(isSet(plannedAtpQuantity_eq) && { 'PlannedATPQuantity.eq': plannedAtpQuantity_eq }),
+    ...(isSet(plannedAtpQuantity_gt) && { 'PlannedATPQuantity.gt': plannedAtpQuantity_gt }),
+    ...(isSet(plannedAtpQuantity_lt) && { 'PlannedATPQuantity.lt': plannedAtpQuantity_lt }),
+    ...(isSet(plannedAtpQuantity_gte) && { 'PlannedATPQuantity.gte': plannedAtpQuantity_gte }),
+    ...(isSet(plannedAtpQuantity_lte) && { 'PlannedATPQuantity.lte': plannedAtpQuantity_lte }),
+    ...(apiVersion === 'v3.1' ? {
+      ...(isSet(totalStockQuantity_eq) && { 'TotalStockQuantity.eq': totalStockQuantity_eq }),
+      ...(isSet(totalStockQuantity_gt) && { 'TotalStockQuantity.gt': totalStockQuantity_gt }),
+      ...(isSet(totalStockQuantity_lt) && { 'TotalStockQuantity.lt': totalStockQuantity_lt }),
+      ...(isSet(totalStockQuantity_gte) && { 'TotalStockQuantity.gte': totalStockQuantity_gte }),
+      ...(isSet(totalStockQuantity_lte) && { 'TotalStockQuantity.lte': totalStockQuantity_lte }),
+      ...(isSet(inventoryAtpQuantity_eq) && { 'InventoryATPQuantity.eq': inventoryAtpQuantity_eq }),
+      ...(isSet(inventoryAtpQuantity_gt) && { 'InventoryATPQuantity.gt': inventoryAtpQuantity_gt }),
+      ...(isSet(inventoryAtpQuantity_lt) && { 'InventoryATPQuantity.lt': inventoryAtpQuantity_lt }),
+      ...(isSet(inventoryAtpQuantity_gte) && { 'InventoryATPQuantity.gte': inventoryAtpQuantity_gte }),
+      ...(isSet(inventoryAtpQuantity_lte) && { 'InventoryATPQuantity.lte': inventoryAtpQuantity_lte }),
+    } : {}),
+    ...(apiVersion === 'v3.2' ? {
+      ...(isSet(undamagedQuantity_eq) && { 'UndamagedQuantity.eq': undamagedQuantity_eq }),
+      ...(isSet(undamagedQuantity_gt) && { 'UndamagedQuantity.gt': undamagedQuantity_gt }),
+      ...(isSet(undamagedQuantity_lt) && { 'UndamagedQuantity.lt': undamagedQuantity_lt }),
+      ...(isSet(undamagedQuantity_gte) && { 'UndamagedQuantity.gte': undamagedQuantity_gte }),
+      ...(isSet(undamagedQuantity_lte) && { 'UndamagedQuantity.lte': undamagedQuantity_lte }),
+      ...(isSet(currentAtpQuantity_eq) && { 'CurrentATPQuantity.eq': currentAtpQuantity_eq }),
+      ...(isSet(currentAtpQuantity_gt) && { 'CurrentATPQuantity.gt': currentAtpQuantity_gt }),
+      ...(isSet(currentAtpQuantity_lt) && { 'CurrentATPQuantity.lt': currentAtpQuantity_lt }),
+      ...(isSet(currentAtpQuantity_gte) && { 'CurrentATPQuantity.gte': currentAtpQuantity_gte }),
+      ...(isSet(currentAtpQuantity_lte) && { 'CurrentATPQuantity.lte': currentAtpQuantity_lte }),
+    } : {}),
+  };
+
+  if (!Object.keys(params).length) {
+    return {
+      ok: false,
+      error: {
+        code: 'INVALID_CRITERIA',
+        message: 'At least one filter is required, and criteria must match the API version.',
+      },
+    };
+  }
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Report/AvailableToPromise/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['criteria'],
+]);
+
+const logiwaReportGetAvailableToPromise = async (
+  credsPayload,
+  criteria,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    criteria,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    criteria,
+    logiwaReportGetAvailableToPromiseSingle,
+    (singleCriteria) => ({
+      args: [
+        credsPayload,
+        {
+          ...singleCriteria,
+          ...options,
+        },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaReportGetAvailableToPromise,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaReportGetAvailableToPromise" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "criteria": { "clientIdentifier_eq": "9f1ea39a-fccc-48af-8986-a35c34fcef8b" }
+  }'
+
+curl -X POST "http://localhost:8000/logiwaReportGetAvailableToPromise" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "criteria": [
+      { "sku_eq": "EXDAL355-15-S/M" },
+      { "sku_eq": "EXD535-1-XXS/XS" }
+    ]
+  }'
+*/

package/api/logiwa/logiwaReportGetInventoryCalculation.js

@@ -0,0 +1,62 @@
+// https://myapi.logiwa.com/swagger/index.html#/Report/get_v3_1_Report_InventoryCalculation_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['warehouseIdentifier_eq'],
+]);
+
+const logiwaReportGetInventoryCalculation = async (
+  credsPayload,
+  warehouseIdentifier_eq,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    warehouseIdentifier_eq,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    'WarehouseIdentifier.eq': warehouseIdentifier_eq,
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Report/InventoryCalculation/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaReportGetInventoryCalculation,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaReportGetInventoryCalculation" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "warehouseIdentifier_eq": "cfbdf154-3052-4e18-84f3-b93b7cde2875"
+  }'
+*/

package/api/logiwa/logiwaReportGetInventorySnapshot.js

@@ -0,0 +1,66 @@
+// https://myapi.logiwa.com/swagger/index.html#/Report/get_v3_1_Report_InventorySnapshot_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaReportGetInventorySnapshot = async (
+  credsPayload,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    warehouseIdentifier_eq,
+    clientIdentifier_eq,
+    locationIdentifier_eq,
+    sku_eq,
+    snapshotDate_bt,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...(warehouseIdentifier_eq && { 'WarehouseIdentifier.eq': warehouseIdentifier_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(locationIdentifier_eq && { 'LocationIdentifier.eq': locationIdentifier_eq }),
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(snapshotDate_bt && { 'SnapshotDate.bt': snapshotDate_bt }),
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Report/InventorySnapshot/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaReportGetInventorySnapshot,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaReportGetInventorySnapshot" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "options": { "clientIdentifier_eq": "9f1ea39a-fccc-48af-8986-a35c34fcef8b" }
+  }'
+*/

package/api/logiwa/logiwaReportGetTotalInventory.js

@@ -0,0 +1,72 @@
+// https://myapi.logiwa.com/swagger/index.html#/Report/get_v3_1_Report_TotalInventory_i__index__s__size_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+const { MAX_PER_PAGE } = require('../logiwa/logiwa.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaReportGetTotalInventory = async (
+  credsPayload,
+  {
+    apiVersion,
+    page = 0,
+    perPage = MAX_PER_PAGE,
+    sku_eq,
+    clientIdentifier_eq,
+    clientIdentifier_in,
+    outOfStock_eq,
+    warehouseIdentifier_eq,
+    warehouseIdentifier_in,
+    productTypeName_eq,
+    productGroupName_eq,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const params = {
+    ...(sku_eq && { 'Sku.eq': sku_eq }),
+    ...(clientIdentifier_eq && { 'ClientIdentifier.eq': clientIdentifier_eq }),
+    ...(clientIdentifier_in && { 'ClientIdentifier.in': clientIdentifier_in }),
+    ...(outOfStock_eq !== undefined && { 'OutOfStock.eq': outOfStock_eq }),
+    ...(warehouseIdentifier_eq && { 'WarehouseIdentifier.eq': warehouseIdentifier_eq }),
+    ...(warehouseIdentifier_in && { 'WarehouseIdentifier.in': warehouseIdentifier_in }),
+    ...(productTypeName_eq && { 'ProductTypeName.eq': productTypeName_eq }),
+    ...(productGroupName_eq && { 'ProductGroupName.eq': productGroupName_eq }),
+  };
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Report/TotalInventory/i/${ page }/s/${ perPage }`,
+    params,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaReportGetTotalInventory,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaReportGetTotalInventory" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "options": { "outOfStock_eq": true }
+  }'
+*/

package/api/logiwa/logiwaWebhookStatusGet.js

@@ -0,0 +1,54 @@
+// https://myapi.logiwa.com/swagger/index.html#/Webhook/get_v3_1_Webhook_status__identifier_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['subscriptionId'],
+]);
+
+const logiwaWebhookStatusGet = async (
+  credsPayload,
+  subscriptionId,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    subscriptionId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: `/Webhook/status/${ subscriptionId }`,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaWebhookStatusGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaWebhookStatusGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "subscriptionId": "68706c98-0198-4671-9a97-4b3e3e59a56d"
+  }'
+*/

package/api/logiwa/logiwaWebhookSubscribe.js

@@ -0,0 +1,64 @@
+// https://myapi.logiwa.com/swagger/index.html#/Webhook/post_v3_1_Webhook_create
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['topic'],
+  ['url'],
+]);
+
+const logiwaWebhookSubscribe = async (
+  credsPayload,
+  topic,
+  url,
+  {
+    apiVersion,
+    clientIdentifier,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    topic,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'post',
+    url: '/Webhook/create',
+    body: {
+      topic,
+      address: url,
+      ...(clientIdentifier ? { clientIdentifier } : { ignoreClient: true }),
+    },
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaWebhookSubscribe,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaWebhookSubscribe" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "topic": "wms/inventory/available",
+    "url": "https://example.com/webhook"
+  }'
+*/

package/api/logiwa/logiwaWebhookUnsubscribe.js

@@ -0,0 +1,54 @@
+// https://myapi.logiwa.com/swagger/index.html#/Webhook/delete_v3_1_Webhook_unsubscribe__subscriptionIdentifier_
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['subscriptionId'],
+]);
+
+const logiwaWebhookUnsubscribe = async (
+  credsPayload,
+  subscriptionId,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    subscriptionId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'delete',
+    url: `/Webhook/unsubscribe/${ subscriptionId }`,
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaWebhookUnsubscribe,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaWebhookUnsubscribe" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" },
+    "subscriptionId": "68706c98-0198-4671-9a97-4b3e3e59a56d"
+  }'
+*/

package/api/logiwa/logiwaWebhooksGet.js

@@ -0,0 +1,48 @@
+// https://myapi.logiwa.com/swagger/index.html#/Webhook/get_v3_1_Webhook_list
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { logiwaClient } = require('../logiwa/logiwa.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const logiwaWebhooksGet = async (
+  credsPayload,
+  {
+    apiVersion,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return logiwaClient.fetch({
+    method: 'get',
+    url: '/Webhook/list',
+    context: {
+      credsPayload,
+      apiVersion,
+    },
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  logiwaWebhooksGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/logiwaWebhooksGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "logiwa" }
+  }'
+*/

package/api/shopify/_example.get.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/things
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyThingsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'thing', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyThingsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyThingsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/shopify/shopifyAbandonedCheckoutsGet.js

@@ -0,0 +1,46 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/queries/abandonedCheckouts
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { shopifyGet } = require('./shopifyGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const shopifyAbandonedCheckoutsGet = async (
+  credsPayload,
+  {
+    ...getterOptions // e.g. limit
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return await shopifyGet(credsPayload, 'abandonedCheckout', { ...getterOptions });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyAbandonedCheckoutsGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyAbandonedCheckoutsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "options": {
+      "limit": 10
+    }
+  }'
+*/