@foxtware/mineral 0.1.17 → 0.1.19

package/api/gorgias/gorgiasGet.js

@@ -0,0 +1,150 @@
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+const { MAX_PER_PAGE } = require('../gorgias/gorgias.constants');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['url'],
+]);
+
+const digResults = (data, resultsKey) => {
+  if (resultsKey) {
+    return data?.[resultsKey] ?? [];
+  }
+
+  if (Array.isArray(data)) {
+    return data;
+  }
+
+  const arrayEntry = Object.entries(data || {}).find(([, value]) => Array.isArray(value));
+  return arrayEntry ? arrayEntry[1] : [];
+};
+
+const gorgiasGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+  return fetchClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        limit: Math.min(perPage, MAX_PER_PAGE),
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const gorgiasGetPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const nextCursor = response?.data?.meta?.next_cursor;
+  if (!nextCursor) {
+    return [true];
+  }
+
+  const { params = {} } = options;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...params,
+        cursor: nextCursor,
+      },
+    },
+  }];
+};
+
+const gorgiasGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    resultsKey = 'data',
+    fetchClient = gorgiasClient,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        perPage,
+        fetchClient,
+      },
+    },
+    {
+      func: gorgiasGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return digResults(response.data, resultsKey);
+      },
+      paginator: gorgiasGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasGet: (...args) => gorgiasGet(false, ...args),
+  gorgiasGetter: (...args) => gorgiasGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "url": "/tickets",
+    "options": {
+      "limit": 10
+    }
+  }'
+*/

package/api/gorgias/gorgiasGetSingle.js

@@ -0,0 +1,26 @@
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+
+const gorgiasGetSingle = async (
+  credsPayload,
+  collectionPath,
+  id,
+  {
+    inspect = false,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+  const normalizedPath = collectionPath.replace(/\/$/, '');
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `${ normalizedPath }/${ id }`,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+module.exports = {
+  gorgiasGetSingle,
+};

package/api/gorgias/gorgiasMessagesGet.js

@@ -0,0 +1,56 @@
+// https://developers.gorgias.com/reference/list-messages
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const gorgiasMessagesGet = async (
+  returnGetter,
+
+  credsPayload,
+  getterOptions = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    '/messages',
+    getterOptions,
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasMessagesGet: (...args) => gorgiasMessagesGet(false, ...args),
+  gorgiasMessagesGetter: (...args) => gorgiasMessagesGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasMessagesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "options": {
+      "params": { "ticket_id": 399815746 },
+      "limit": 20
+    }
+  }'
+*/

package/api/gorgias/gorgiasTagsGet.js

@@ -0,0 +1,52 @@
+// https://developers.gorgias.com/reference/list-tags
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const gorgiasTagsGet = async (
+  returnGetter,
+
+  credsPayload,
+  getterOptions = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    '/tags',
+    getterOptions,
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTagsGet: (...args) => gorgiasTagsGet(false, ...args),
+  gorgiasTagsGetter: (...args) => gorgiasTagsGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTagsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" }
+  }'
+*/

package/api/gorgias/gorgiasTicketCreate.js

@@ -0,0 +1,66 @@
+// https://developers.gorgias.com/reference/create-ticket
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ticketBody', valueProvided],
+]);
+
+const gorgiasTicketCreate = async (
+  credsPayload,
+  ticketBody,
+  {
+    inspect = false,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ticketBody,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/tickets',
+      body: ticketBody,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "ticketBody": {
+      "customer": { "email": "customer@example.com" },
+      "messages": [
+        {
+          "channel": "email",
+          "via": "email",
+          "from_agent": false,
+          "body_text": "Hello"
+        }
+      ]
+    }
+  }'
+*/

package/api/gorgias/gorgiasTicketGet.js

@@ -0,0 +1,70 @@
+// https://developers.gorgias.com/reference/get-ticket
+
+const { ArgsWarden, actionSingleOrMultiple } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGetSingle } = require('../gorgias/gorgiasGetSingle');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ticketId'],
+]);
+
+const gorgiasTicketGetSingle = async (
+  credsPayload,
+  ticketId,
+  options = {},
+) => {
+  return gorgiasGetSingle(
+    credsPayload,
+    '/tickets',
+    ticketId,
+    options,
+  );
+};
+
+const gorgiasTicketGet = async (
+  credsPayload,
+  ticketId,
+  {
+    queueRunOptions,
+    ...options
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ticketId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    ticketId,
+    gorgiasTicketGetSingle,
+    (ticketIdItem) => ({
+      args: [credsPayload, ticketIdItem, options],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "ticketId": "399815746"
+  }'
+*/

package/api/gorgias/gorgiasTicketMessageCreate.js

@@ -0,0 +1,65 @@
+// https://developers.gorgias.com/reference/create-ticket-message
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ticketId'],
+  ['messageBody', valueProvided],
+]);
+
+const gorgiasTicketMessageCreate = async (
+  credsPayload,
+  ticketId,
+  messageBody,
+  {
+    inspect = false,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ticketId,
+    messageBody,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: `/tickets/${ ticketId }/messages`,
+      body: messageBody,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketMessageCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketMessageCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "ticketId": "399815746",
+    "messageBody": {
+      "channel": "email",
+      "via": "api",
+      "from_agent": true,
+      "body_text": "Thanks for reaching out — we are looking into this."
+    }
+  }'
+*/

package/api/gorgias/gorgiasTicketMessagesGet.js

@@ -0,0 +1,66 @@
+// https://developers.gorgias.com/reference/list-messages
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ticketId'],
+]);
+
+const gorgiasTicketMessagesGet = async (
+  returnGetter,
+
+  credsPayload,
+  ticketId,
+  {
+    params,
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ticketId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    '/messages',
+    {
+      params: {
+        ticket_id: ticketId,
+        ...params,
+      },
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketMessagesGet: (...args) => gorgiasTicketMessagesGet(false, ...args),
+  gorgiasTicketMessagesGetter: (...args) => gorgiasTicketMessagesGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketMessagesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "ticketId": "399815746",
+    "options": { "limit": 20 }
+  }'
+*/

package/api/gorgias/gorgiasTicketUpdate.js

@@ -0,0 +1,62 @@
+// https://developers.gorgias.com/reference/update-ticket
+
+const { ArgsWarden, valueProvided } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasClient } = require('../gorgias/gorgias.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ticketId'],
+  ['ticketBody', valueProvided],
+]);
+
+const gorgiasTicketUpdate = async (
+  credsPayload,
+  ticketId,
+  ticketBody,
+  {
+    inspect = false,
+    fetchClient = gorgiasClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ticketId,
+    ticketBody,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'put',
+      url: `/tickets/${ ticketId }`,
+      body: ticketBody,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "ticketId": "399815746",
+    "ticketBody": {
+      "status": "closed"
+    }
+  }'
+*/

package/api/gorgias/gorgiasTicketsGet.js

@@ -0,0 +1,58 @@
+// https://developers.gorgias.com/reference/list-tickets
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { gorgiasGet, gorgiasGetter } = require('../gorgias/gorgiasGet');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const gorgiasTicketsGet = async (
+  returnGetter,
+
+  credsPayload,
+  getterOptions = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getterArgs = [
+    credsPayload,
+    '/tickets',
+    getterOptions,
+  ];
+
+  return returnGetter
+    ? gorgiasGetter(...getterArgs)
+    : gorgiasGet(...getterArgs);
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  gorgiasTicketsGet: (...args) => gorgiasTicketsGet(false, ...args),
+  gorgiasTicketsGetter: (...args) => gorgiasTicketsGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/gorgiasTicketsGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "gorgias" },
+    "options": {
+      "params": {
+        "order_by": "created_datetime:desc"
+      },
+      "limit": 10
+    }
+  }'
+*/