@foxtware/mineral 0.1.14 → 0.1.16

package/api/shopify/shopifySegmentsGet.js

@@ -15,7 +15,7 @@ const shopifySegmentsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {

package/api/shopify/shopifyStoreCreditAccountCredit.js

@@ -0,0 +1,144 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/storeCreditAccountCredit
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, everyIfArray, ArgsWarden, valueProvided } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const creditPayloadValidator = (creditPayload) => {
+  return valueProvided(creditPayload?.amount)
+    && creditPayload?.currencyCode;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerOrAccountGid'],
+  ['creditPayload', (i) => everyIfArray(creditPayloadValidator, i)],
+]);
+
+const defaultReturnSchema = `
+  storeCreditAccountTransaction {
+    amount {
+      amount
+      currencyCode
+    }
+    account {
+      id
+      balance {
+        amount
+        currencyCode
+      }
+    }
+  }
+`.trim();
+
+const shopifyStoreCreditAccountCreditSingle = async (
+  credsPayload,
+  ownerOrAccountGid,
+  creditPayload,
+  {
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const {
+    amount,
+    currencyCode,
+    expiresAt,
+  } = creditPayload;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'storeCreditAccountCredit',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: ownerOrAccountGid,
+        },
+        creditInput: {
+          type: 'StoreCreditAccountCreditInput!',
+          value: {
+            creditAmount: {
+              amount: String(amount),
+              currencyCode,
+            },
+            ...(expiresAt && { expiresAt }),
+          },
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyStoreCreditAccountCredit = async (
+  credsPayload,
+  ownerOrAccountGid,
+  creditPayload,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ownerOrAccountGid,
+    creditPayload,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    creditPayload,
+    shopifyStoreCreditAccountCreditSingle,
+    (creditPayloadItem) => ({
+      args: [
+        credsPayload,
+        ownerOrAccountGid,
+        creditPayloadItem,
+        { apiVersion, returnSchema },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStoreCreditAccountCredit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountCredit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/Customer/5736896757832",
+    "creditPayload": {
+      "amount": "10.00",
+      "currencyCode": "AUD"
+    }
+  }'
+
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountCredit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/Customer/5736896757832",
+    "creditPayload": [
+      { "amount": "10.00", "currencyCode": "AUD", "expiresAt": "2027-07-16T13:59:59Z" },
+      { "amount": "5.00", "currencyCode": "USD" }
+    ]
+  }'
+*/

package/api/shopify/shopifyStoreCreditAccountDebit.js

@@ -0,0 +1,132 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/storeCreditAccountDebit
+
+const { credsValidator } = require('../validators');
+const { actionSingleOrMultiple, everyIfArray, ArgsWarden } = require('../utils');
+const { shopifyMutationDo } = require('../shopify/shopifyMutationDo');
+
+const debitAmountValidator = (debitAmount) => {
+  return debitAmount?.amount !== undefined
+    && debitAmount?.amount !== null
+    && debitAmount?.currencyCode;
+};
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['ownerOrAccountGid'],
+  ['debitAmount', (i) => everyIfArray(debitAmountValidator, i)],
+]);
+
+const defaultReturnSchema = `
+  storeCreditAccountTransaction {
+    amount {
+      amount
+      currencyCode
+    }
+    account {
+      id
+      balance {
+        amount
+        currencyCode
+      }
+    }
+  }
+`.trim();
+
+const shopifyStoreCreditAccountDebitSingle = async (
+  credsPayload,
+  ownerOrAccountGid,
+  debitAmount,
+  {
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const {
+    amount,
+    currencyCode,
+  } = debitAmount;
+
+  return shopifyMutationDo(
+    credsPayload,
+    'storeCreditAccountDebit',
+    {
+      mutationVariables: {
+        id: {
+          type: 'ID!',
+          value: ownerOrAccountGid,
+        },
+        debitInput: {
+          type: 'StoreCreditAccountDebitInput!',
+          value: {
+            debitAmount: {
+              amount: String(amount),
+              currencyCode,
+            },
+          },
+        },
+      },
+      returnSchema,
+      apiVersion,
+    },
+  );
+};
+
+const shopifyStoreCreditAccountDebit = async (
+  credsPayload,
+  ownerOrAccountGid,
+  debitAmount,
+  {
+    queueRunOptions,
+    apiVersion,
+    returnSchema = defaultReturnSchema,
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    ownerOrAccountGid,
+    debitAmount,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return actionSingleOrMultiple(
+    debitAmount,
+    shopifyStoreCreditAccountDebitSingle,
+    (debitAmountItem) => ({
+      args: [
+        credsPayload,
+        ownerOrAccountGid,
+        debitAmountItem,
+        { apiVersion, returnSchema },
+      ],
+    }),
+    {
+      ...(queueRunOptions ? { queueRunOptions } : {}),
+    },
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyStoreCreditAccountDebit,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyStoreCreditAccountDebit" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "ownerOrAccountGid": "gid://shopify/StoreCreditAccount/11862088",
+    "debitAmount": {
+      "amount": "10.00",
+      "currencyCode": "AUD"
+    }
+  }'
+*/

package/api/shopify/shopifyTagsRemoveBulk.js

@@ -0,0 +1,77 @@
+// https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsRemove
+
+const { credsValidator } = require('../validators');
+const { ArgsWarden } = require('../utils');
+const { shopifyBulkMutationDo } = require('./shopifyBulkMutationDo');
+
+const tagsRemoveBulkMutation = `
+  mutation call($id: ID!, $tags: [String!]!) {
+    tagsRemove(id: $id, tags: $tags) {
+      node {
+        id
+      }
+      userErrors {
+        field
+        message
+      }
+    }
+  }
+`.trim();
+
+const argsWarden = new ArgsWarden([
+  ['credsPayload', credsValidator],
+  ['gids', Array.isArray],
+  ['tags', Array.isArray],
+]);
+
+const shopifyTagsRemoveBulk = async (
+  credsPayload,
+  gids,
+  tags,
+  {
+    ...bulkMutationOptions
+  } = {},
+) => {
+
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    gids,
+    tags,
+  });
+  if (rejectResponse) {
+    return rejectResponse;
+  }
+
+  return shopifyBulkMutationDo(
+    credsPayload,
+    {
+      mutation: tagsRemoveBulkMutation,
+      input: {
+        data: gids.map((gid) => ({
+          id: gid,
+          tags,
+        })),
+      },
+    },
+    bulkMutationOptions,
+  );
+};
+
+const funcApiConfig = {
+  argsWarden,
+};
+
+module.exports = {
+  shopifyTagsRemoveBulk,
+  funcApiConfig,
+};
+
+/*
+curl -X POST "http://localhost:8000/shopifyTagsRemoveBulk" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "credsPayload": { "credsPath": "shopify.au" },
+    "gids": ["gid://shopify/Customer/123", "gid://shopify/Customer/456"],
+    "tags": ["martian_sympathisers"]
+  }'
+*/

package/api/shopify/shopifyThemeDelete.js

@@ -44,7 +44,10 @@ const shopifyThemeDelete = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    themeId,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyThemeDuplicate.js

@@ -19,7 +19,10 @@ const shopifyThemeDuplicate = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload, themeId });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+    themeId,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }

package/api/shopify/shopifyThemeGet.js

@@ -20,8 +20,8 @@ const shopifyThemeGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
-    credsPayload, 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
     themeId,
   });
   if (rejectResponse) {

package/api/shopify/shopifyThemesGet.js

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

package/api/shopify/shopifyUrlRedirectsGet.js

@@ -15,7 +15,7 @@ const shopifyUrlRedirectsGet = async (
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {

package/api/shopify/shopifyWebhookSubscriptionsGet.js

@@ -2,27 +2,39 @@
 
 const { ArgsWarden } = require('../utils');
 const { credsValidator } = require('../validators');
-const { shopifyGet } = require('./shopifyGet');
+const { shopifyGet, shopifyGetter } = require('./shopifyGet');
 
 const argsWarden = new ArgsWarden([
   ['credsPayload', credsValidator],
 ]);
 
 const shopifyWebhookSubscriptionsGet = async (
+  returnGetter, // Always bound
+
   credsPayload,
   {
     ...getterOptions // e.g. limit
   } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ 
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
     credsPayload,
   });
   if (rejectResponse) {
     return rejectResponse;
   }
 
-  return await shopifyGet(credsPayload, 'webhookSubscription', { ...getterOptions });
+  const getterArgs = [
+    credsPayload, 
+    'webhookSubscription', 
+    {
+      ...getterOptions,
+    },
+  ];
+
+  return returnGetter
+    ? shopifyGetter(...getterArgs)
+    : shopifyGet(...getterArgs);
 };
 
 const funcApiConfig = {
@@ -30,7 +42,8 @@ const funcApiConfig = {
 };
 
 module.exports = {
-  shopifyWebhookSubscriptionsGet,
+  shopifyWebhookSubscriptionsGet: (...args) => shopifyWebhookSubscriptionsGet(false, ...args),
+  shopifyWebhookSubscriptionsGetter: (...args) => shopifyWebhookSubscriptionsGet(true, ...args),
   funcApiConfig,
 };
 

package/api/snowflake/docs.md

@@ -0,0 +1,8 @@
+# Snowflake
+
+- [Developer documentation](https://docs.snowflake.com/en/developer-guide)
+- [SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/index)
+- [SQL API reference](https://docs.snowflake.com/en/developer-guide/sql-api/reference)
+- [Authenticating to the SQL API](https://docs.snowflake.com/en/developer-guide/sql-api/authenticating)
+
+Account-scoped HTTPS JSON API at `https://{account_identifier}.snowflakecomputing.com/api/v2/statements` for submitting SQL, polling handles, and canceling runs, authenticated with OAuth or key-pair JWT rather than a single static API key.

package/api/starshipit/starshipitAddressesGet.js

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

package/api/starshipit/starshipitOrdersListShipped.js

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

package/api/starshipit/starshipitProductsGet.js

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

package/api/stripe/_example.js

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

package/api/stripe/stripeChargesGet.js

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

package/api/stripe/stripeRefundsGet.js

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

package/api/stylearcade/stylearcadeDataGet.js

@@ -10,33 +10,41 @@ const argsWarden = new ArgsWarden([
 
 const stylearcadeDataGet = async (
   credsPayload,
-  options = {},
+  {
+    ...getterOptions
+  } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }
 
   return stylearcadeGet(credsPayload, {
     nodeName: 'records',
-    ...options,
+    ...getterOptions,
   });
 };
 
 const stylearcadeDataGetter = async (
   credsPayload,
-  options = {},
+  {
+    ...getterOptions
+  } = {},
 ) => {
 
-  const rejectResponse = await argsWarden.responseIfRejectingArgs({ credsPayload });
+  const rejectResponse = await argsWarden.responseIfRejectingArgs({
+    credsPayload,
+  });
   if (rejectResponse) {
     return rejectResponse;
   }
 
   return stylearcadeGetter(credsPayload, {
     nodeName: 'records',
-    ...options,
+    ...getterOptions,
   });
 };
 

package/api/stylearcade/stylearcadeMetadataGet.js

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

package/api/tagalys/docs.md

@@ -0,0 +1,7 @@
+# Tagalys
+
+- [Custom integration API (V1)](https://static.tagalys.com/docs/api/custom-integration/)
+- [Support: custom platform integration](https://support.tagalys.com/how-can-i-install-tagalys-to-my-custom-built-ecommerce-platform)
+- [Integration overview](https://support.tagalys.com/integration)
+
+Region-specific HTTPS origins with POST JSON (and FormData for feeds); every call includes an `identification` object (`client_code`, `api_key`, `store_id`) using the private key for sync/config and the public key for storefront search and analytics.

package/api/telnyx/docs.md

@@ -0,0 +1,6 @@
+# Telnyx
+
+- [Developer documentation](https://developers.telnyx.com/docs)
+- [API reference](https://developers.telnyx.com/api-reference)
+
+REST JSON at `https://api.telnyx.com/v2`, authenticated with `Authorization: Bearer`.

package/api/telnyx/telnyx.constants.js

@@ -0,0 +1,7 @@
+const TELNYX_API_BASE_URL = 'https://api.telnyx.com/v2';
+const MAX_PER_PAGE = 250;
+
+module.exports = {
+  TELNYX_API_BASE_URL,
+  MAX_PER_PAGE,
+};

package/api/telnyx/telnyx.utils.js

@@ -0,0 +1,37 @@
+const { TELNYX_API_BASE_URL } = require('../telnyx/telnyx.constants');
+const { resolveCreds, useBaseUrl } = require('../pipelineSteps');
+const {
+  FetchClient,
+  fetchClientCommonSteps,
+} = require('../utils');
+
+const useAuthHeaders = async (state) => {
+  const { requestPayload, context } = state;
+  const { creds } = context;
+  const { API_KEY } = creds;
+
+  return {
+    requestPayload: {
+      ...requestPayload,
+      headers: {
+        Authorization: `Bearer ${ API_KEY }`,
+        ...requestPayload.headers,
+      },
+    },
+  };
+};
+
+const telnyxClient = new FetchClient({
+  pipeline: [
+    resolveCreds,
+    useBaseUrl(TELNYX_API_BASE_URL),
+    useAuthHeaders,
+    'fetch',
+    fetchClientCommonSteps.unwrapData,
+    fetchClientCommonSteps.exitEarlyOnNotOk,
+  ],
+});
+
+module.exports = {
+  telnyxClient,
+};