@foxtware/mineral 0.1.0 → 0.1.2

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
+    }
+  }'
+*/

package/api/shopify/shopifyArticlesGet.js

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

package/api/shopify/shopifyBlogsGet.js

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

package/api/shopify/shopifyBulkOperationsGet.js

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

package/api/shopify/shopifyCatalogsGet.js

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

package/api/shopify/shopifyChannelsGet.js

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