@foxtware/mineral 0.1.15 → 0.1.16

package/api/telnyx/telnyxNumberOrderCreate.js

@@ -0,0 +1,64 @@
+// https://developers.telnyx.com/api-reference/phone-numbers/create-a-number-order
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const orderValidator = (order) => {
+  return order && typeof order === 'object' && Object.keys(order).length > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['order', orderValidator],
+]);
+
+const telnyxNumberOrderCreate = async (
+  credsPayload,
+  order,
+  {
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    order,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/number_orders',
+      body: order,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxNumberOrderCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxNumberOrderCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "order": {
+      "phone_numbers": [
+        { "phone_number": "+61312345678" }
+      ]
+    }
+  }'
+*/

package/api/telnyx/telnyxPhoneNumberGet.js

@@ -0,0 +1,59 @@
+// https://developers.telnyx.com/api-reference/phone-numbers/retrieve-a-phone-number
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const idValidator = (id) => typeof id === 'string' && id.length > 0;
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['phoneNumberId', idValidator],
+]);
+
+const telnyxPhoneNumberGet = async (
+  credsPayload,
+  phoneNumberId,
+  {
+    params,
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    phoneNumberId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/phone_numbers/${ phoneNumberId }`,
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxPhoneNumberGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxPhoneNumberGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "phoneNumberId": "00000000-0000-0000-0000-000000000000"
+  }'
+*/

package/api/telnyx/telnyxPhoneNumberUpdate.js

@@ -0,0 +1,68 @@
+// https://developers.telnyx.com/api-reference/phone-numbers/update-a-phone-number
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const idValidator = (id) => typeof id === 'string' && id.length > 0;
+
+const bodyValidator = (body) => {
+  return body && typeof body === 'object' && Object.keys(body).length > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['phoneNumberId', idValidator],
+  ['body', bodyValidator],
+]);
+
+const telnyxPhoneNumberUpdate = async (
+  credsPayload,
+  phoneNumberId,
+  body,
+  {
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    phoneNumberId,
+    body,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'patch',
+      url: `/phone_numbers/${ phoneNumberId }`,
+      body,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxPhoneNumberUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxPhoneNumberUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "phoneNumberId": "00000000-0000-0000-0000-000000000000",
+    "body": {
+      "messaging_profile_id": "00000000-0000-0000-0000-000000000001"
+    }
+  }'
+*/

package/api/telnyx/telnyxPhoneNumbersGet.js

@@ -0,0 +1,53 @@
+// https://developers.telnyx.com/api-reference/phone-numbers/list-phone-numbers
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const telnyxPhoneNumbersGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/phone_numbers',
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxPhoneNumbersGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxPhoneNumbersGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" }
+  }'
+*/

package/api/telnyx/telnyxWebhookDeliveriesGet.js

@@ -0,0 +1,58 @@
+// https://developers.telnyx.com/api-reference/webhooks/list-webhook-deliveries
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+]);
+
+const telnyxWebhookDeliveriesGet = async (
+  credsPayload,
+  {
+    params,
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: '/webhook_deliveries',
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxWebhookDeliveriesGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxWebhookDeliveriesGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "options": {
+      "params": {
+        "filter[status][eq]": "failed"
+      }
+    }
+  }'
+*/

package/api/threeclicks/threeclicksCollectionsGet.js

@@ -9,7 +9,9 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksCollectionsGet = async (credsPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderCreate.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderCreate = async (credsPayload, orderPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderCreateBulk.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderCreateBulk = async (credsPayload, orderPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderGet.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderGet = async (credsPayload, orderNumber) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderNumber,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderQuantitiesGet.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderQuantitiesGet = async (credsPayload, orderNumber) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderNumber,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderQuantityCreate.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderQuantityCreate = async (credsPayload, quantityPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, quantityPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    quantityPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderQuantityCreateBulk.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderQuantityCreateBulk = async (credsPayload, quantityPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, quantityPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    quantityPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrderUpdate.js

@@ -11,7 +11,11 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksPurchaseOrderUpdate = async (credsPayload, orderNumber, orderPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, orderNumber, orderPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    orderNumber,
+    orderPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksPurchaseOrdersGet.js

@@ -7,7 +7,9 @@ const { threeclicksGet } = require('../threeclicks/threeclicksGet');
 const argsWarden = new ArgsWarden([['credsPayload', credsValidator]]);
 
 const threeclicksPurchaseOrdersGet = async (credsPayload, { mode = 'all', ...getterOptions } = {}) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksGet(credsPayload, '/search/advanced/order', { params: { mode }, ...getterOptions });
 };

package/api/threeclicks/threeclicksShipmentCreate.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksShipmentCreate = async (credsPayload, shipmentPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentGet.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksShipmentGet = async (credsPayload, shipmentNumber) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentNumber,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentOrderAdd.js

@@ -11,7 +11,11 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksShipmentOrderAdd = async (credsPayload, shipmentNumber, orderNumber) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentNumber, orderNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentNumber,
+    orderNumber,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentOrderQuantityCreate.js

@@ -11,7 +11,11 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksShipmentOrderQuantityCreate = async (credsPayload, shipmentNumber, quantityPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentNumber, quantityPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentNumber,
+    quantityPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentQuantityUpdate.js

@@ -11,7 +11,11 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksShipmentQuantityUpdate = async (credsPayload, shipmentNumber, quantityPayload) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentNumber, quantityPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentNumber,
+    quantityPayload,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentStatusUpdate.js

@@ -18,7 +18,11 @@ const threeclicksShipmentStatusUpdate = async (
     isUpdateAllAssociatedOrdersToCompletedStatus = true,
   } = {},
 ) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, shipmentNumber, status });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    shipmentNumber,
+    status,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksShipmentsGet.js

@@ -16,7 +16,9 @@ const threeclicksShipmentsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) return rejectResponse;
 
   const updatedSinceUnix = updatedSinceDaysAgo

package/api/threeclicks/threeclicksSignatureCalculate.js

@@ -1,6 +1,6 @@
 // https://g40-server.instance.3clickscloud.com/swagger-ui/index.html
 
-const { ArgsWarden, credsFromPayload } = require('../utils');
+const { ArgsWarden, credsFromPayload, normalise } = require('../utils');
 const { credsValidator } = require('../validators');
 const {
   threeclicksSignatureCalculate,
@@ -30,16 +30,16 @@ const threeclicksSignatureCalculateEndpoint = async (
   }
 
   const creds = await credsFromPayload(credsPayload);
-  const normalizedMethod = method.toLowerCase();
+  const normalisedMethod = normalise(method);
   const data = getSignatureData({
-    method: normalizedMethod,
+    method: normalisedMethod,
     params,
     body,
   });
 
   const result = threeclicksSignatureCalculate({
     creds,
-    method: normalizedMethod,
+    method: normalisedMethod,
     data,
   });
 

package/api/threeclicks/threeclicksStyleCodesGet.js

@@ -14,7 +14,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksStyleCodesGet = async (credsPayload, codesFor) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, codesFor });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    codesFor,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksStyleColourDelete.js

@@ -11,7 +11,11 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksStyleColourDelete = async (credsPayload, styleNumber, styleColoursizeId) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, styleNumber, styleColoursizeId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    styleNumber,
+    styleColoursizeId,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksStyleDelete.js

@@ -10,7 +10,10 @@ const argsWarden = new ArgsWarden([
 ]);
 
 const threeclicksStyleDelete = async (credsPayload, styleNumber) => {
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, styleNumber });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    styleNumber,
+  });
   if (rejectResponse) return rejectResponse;
   return threeclicksClient.fetch({
     requestPayload: {

package/api/threeclicks/threeclicksStylesGet.js

@@ -16,7 +16,9 @@ const threeclicksStylesGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/upstash/upstashDel.js

@@ -12,7 +12,10 @@ const upstashDel = async (
   key,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, key });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    key,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/upstash/upstashExists.js

@@ -12,7 +12,10 @@ const upstashExists = async (
   key,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, key });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    key,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/upstash/upstashGet.js

@@ -12,7 +12,10 @@ const upstashGet = async (
   key,
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, key });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    key,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }