@foxtware/mineral 0.1.14 → 0.1.16

package/api/telnyx/telnyxAvailablePhoneNumbersGet.js

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

package/api/telnyx/telnyxBalanceGet.js

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

package/api/telnyx/telnyxGet.js

@@ -0,0 +1,151 @@
+// https://developers.telnyx.com/api
+
+const { ArgsWarden, Getter } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+const { MAX_PER_PAGE } = require('../telnyx/telnyx.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 telnyxGetPacket = async (
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+  } = {},
+) => {
+  return telnyxClient.fetch({
+    requestPayload: {
+      url,
+      params: {
+        'page[size]': Math.min(perPage, MAX_PER_PAGE),
+        ...params,
+      },
+    },
+    context: {
+      credsPayload,
+    },
+  });
+};
+
+const telnyxGetPaginator = async (currentParams, response) => {
+  const { args, options } = currentParams;
+
+  if (!response?.ok) {
+    return [true];
+  }
+
+  const nextPage = response?.data?.meta?.page_number;
+  const totalPages = response?.data?.meta?.total_pages;
+  if (!nextPage || !totalPages || nextPage >= totalPages) {
+    return [true];
+  }
+
+  const { params = {} } = options;
+
+  return [false, {
+    args,
+    options: {
+      ...options,
+      params: {
+        ...params,
+        'page[number]': nextPage + 1,
+      },
+    },
+  }];
+};
+
+const telnyxGet = async (
+  returnGetter,
+
+  credsPayload,
+  url,
+  {
+    params,
+    perPage = MAX_PER_PAGE,
+    resultsKey = 'data',
+    ...getterOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    url,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  const getter = new Getter(
+    {
+      args: [credsPayload, url],
+      options: {
+        params,
+        perPage,
+      },
+    },
+    {
+      func: telnyxGetPacket,
+      digester: (response) => {
+        if (!response?.ok) {
+          return [];
+        }
+
+        return digResults(response.data, resultsKey);
+      },
+      paginator: telnyxGetPaginator,
+      ...getterOptions,
+    },
+  );
+
+  if (returnGetter) {
+    return getter;
+  }
+
+  const data = await getter.run({ returnAll: true });
+
+  return {
+    ok: true,
+    data,
+  };
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxGet: (...args) => telnyxGet(false, ...args),
+  telnyxGetter: (...args) => telnyxGet(true, ...args),
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "url": "/phone_numbers",
+    "options": {
+      "resultsKey": "data",
+      "limit": 5
+    }
+  }'
+*/

package/api/telnyx/telnyxMessageGet.js

@@ -0,0 +1,59 @@
+// https://developers.telnyx.com/api-reference/messages/retrieve-a-message
+
+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],
+  ['messageId', idValidator],
+]);
+
+const telnyxMessageGet = async (
+  credsPayload,
+  messageId,
+  {
+    params,
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    messageId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/messages/${ messageId }`,
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxMessageGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxMessageGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "messageId": "00000000-0000-0000-0000-000000000000"
+  }'
+*/

package/api/telnyx/telnyxMessageSend.js

@@ -0,0 +1,65 @@
+// https://developers.telnyx.com/api-reference/messages/send-a-message
+
+const { ArgsWarden, objHasAny } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const messageValidator = (message) => {
+  return objHasAny(message, ['from', 'to', 'text']);
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['message', messageValidator],
+]);
+
+const telnyxMessageSend = async (
+  credsPayload,
+  message,
+  {
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    message,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/messages',
+      body: message,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxMessageSend,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxMessageSend" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "message": {
+      "from": "+15551234567",
+      "to": "+15559876543",
+      "text": "Hello from Mineral",
+      "messaging_profile_id": "00000000-0000-0000-0000-000000000000"
+    }
+  }'
+*/

package/api/telnyx/telnyxMessagesGet.js

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

package/api/telnyx/telnyxMessagingProfileCreate.js

@@ -0,0 +1,62 @@
+// https://developers.telnyx.com/api-reference/messaging/create-a-messaging-profile
+
+const { ArgsWarden } = require('../utils');
+const { credsValidator } = require('../validators');
+const { telnyxClient } = require('../telnyx/telnyx.utils');
+
+const profileValidator = (profile) => {
+  return profile && typeof profile === 'object' && Object.keys(profile).length > 0;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['profile', profileValidator],
+]);
+
+const telnyxMessagingProfileCreate = async (
+  credsPayload,
+  profile,
+  {
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    profile,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'post',
+      url: '/messaging_profiles',
+      body: profile,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxMessagingProfileCreate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxMessagingProfileCreate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "profile": {
+      "name": "Mineral test profile"
+    }
+  }'
+*/

package/api/telnyx/telnyxMessagingProfileGet.js

@@ -0,0 +1,59 @@
+// https://developers.telnyx.com/api-reference/messaging/retrieve-a-messaging-profile
+
+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],
+  ['messagingProfileId', idValidator],
+]);
+
+const telnyxMessagingProfileGet = async (
+  credsPayload,
+  messagingProfileId,
+  {
+    params,
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    messagingProfileId,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'get',
+      url: `/messaging_profiles/${ messagingProfileId }`,
+      params,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxMessagingProfileGet,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxMessagingProfileGet" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "messagingProfileId": "00000000-0000-0000-0000-000000000000"
+  }'
+*/

package/api/telnyx/telnyxMessagingProfileUpdate.js

@@ -0,0 +1,68 @@
+// https://developers.telnyx.com/api-reference/messaging/update-a-messaging-profile
+
+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],
+  ['messagingProfileId', idValidator],
+  ['body', bodyValidator],
+]);
+
+const telnyxMessagingProfileUpdate = async (
+  credsPayload,
+  messagingProfileId,
+  body,
+  {
+    inspect = false,
+    fetchClient = telnyxClient,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    messagingProfileId,
+    body,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return fetchClient.fetch({
+    requestPayload: {
+      method: 'patch',
+      url: `/messaging_profiles/${ messagingProfileId }`,
+      body,
+    },
+    context: { credsPayload },
+    inspect,
+  });
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  telnyxMessagingProfileUpdate,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/telnyxMessagingProfileUpdate" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "telnyx" },
+    "messagingProfileId": "00000000-0000-0000-0000-000000000000",
+    "body": {
+      "webhook_url": "https://example.com/telnyx/webhook"
+    }
+  }'
+*/

package/api/telnyx/telnyxMessagingProfilesGet.js

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