master-zapier-plan-draft/vendor/zapier-platform/example-apps/resource/resources/recipe.js

const _sharedBaseUrl = 'https://auth-json-server.zapier-staging.com';

const getRecipe = (z, bundle) => {
  return z
    .request({
      url: `${_sharedBaseUrl}/recipes/${bundle.inputData.id}`,
    })
    .then((response) => response.data);
};

const listRecipes = (z, bundle) => {
  return z
    .request({
      url: _sharedBaseUrl + '/recipes',
      params: {
        style: bundle.inputData.style,
      },
    })
    .then((response) => response.data);
};

const createRecipe = (z, bundle) => {
  const requestOptions = {
    url: _sharedBaseUrl + '/recipes',
    method: 'POST',
    body: {
      name: bundle.inputData.name,
      directions: bundle.inputData.directions,
      authorId: bundle.inputData.authorId,
    },
    headers: {
      'content-type': 'application/json',
    },
  };

  return z.request(requestOptions).then((response) => response.data);
};

const searchRecipe = (z, bundle) => {
  return z
    .request({
      url: _sharedBaseUrl + '/recipes',
      params: {
        nameSearch: bundle.inputData.name,
      },
    })
    .then((response) => {
      const matchingRecipes = response.data;

      // Only return the first matching recipe
      if (matchingRecipes && matchingRecipes.length) {
        return [matchingRecipes[0]];
      }

      return [];
    });
};

const sample = {
  id: 1,
  createdAt: 1472069465,
  name: 'Best Spagetti Ever',
  authorId: 1,
  directions: '1. Boil Noodles\n2.Serve with sauce',
  style: 'italian',
};

// This file exports a Recipe resource. The definition below contains all of the keys available,
// and implements the list and create methods.
module.exports = {
  key: 'recipe',
  noun: 'Recipe',
  // The get method is used by Zapier to fetch a complete representation of a record. This is helpful when the HTTP
  // response from a create call only return an ID, or a search that only returns a minimuml representation of the
  // record. Zapier will follow these up with the get() to retrieve the entire object.
  get: {
    display: {
      label: 'Get Recipe',
      description: 'Gets a recipe.',
    },
    operation: {
      inputFields: [{ key: 'id', required: true }],
      perform: getRecipe,
      sample: sample,
    },
  },
  // The list method on this resource becomes a Trigger on the app. Zapier will use polling to watch for new records
  list: {
    display: {
      label: 'New Recipe',
      description: 'Trigger when a new recipe is added.',
    },
    operation: {
      inputFields: [
        {
          key: 'style',
          type: 'string',
          helpText: 'Explain what style of cuisine this is.',
        },
      ],
      perform: listRecipes,
      sample: sample,
    },
  },
  // If your app supports webhooks, you can define a hook method instead of a list method.
  // Zapier will turn this into a webhook Trigger on the app.
  // hook: {
  //
  // },

  // The create method on this resource becomes a Write on this app
  create: {
    display: {
      label: 'Create Recipe',
      description: 'Creates a new recipe.',
    },
    operation: {
      inputFields: [
        { key: 'name', required: true, type: 'string' },
        {
          key: 'directions',
          required: true,
          type: 'text',
          helpText: 'Explain how should one make the recipe, step by step.',
        },
        {
          key: 'authorId',
          required: true,
          type: 'integer',
          label: 'Author ID',
        },
        {
          key: 'style',
          required: false,
          type: 'string',
          helpText: 'Explain what style of cuisine this is.',
        },
      ],
      perform: createRecipe,
      sample: sample,
    },
  },
  // The search method on this resource becomes a Search on this app
  search: {
    display: {
      label: 'Find Recipe',
      description: 'Finds an existing recipe by name.',
    },
    operation: {
      inputFields: [{ key: 'name', required: true, type: 'string' }],
      perform: searchRecipe,
      sample: sample,
    },
  },

  // In cases where Zapier needs to show an example record to the user, but we are unable to get a live example
  // from the API, Zapier will fallback to this hard-coded sample. It should reflect the data structure of
  // returned records, and have obviously dummy values that we can show to any user.
  sample: sample,

  // If the resource can have fields that are custom on a per-user basis, define a function to fetch the custom
  // field definitions. The result will be used to augment the sample.
  // outputFields: () => { return []; }
  // Alternatively, a static field definition should be provided, to specify labels for the fields
  outputFields: [
    { key: 'id', label: 'ID' },
    { key: 'createdAt', label: 'Created At' },
    { key: 'name', label: 'Name' },
    { key: 'directions', label: 'Directions' },
    { key: 'authorId', label: 'Author ID' },
    { key: 'style', label: 'Style' },
  ],
};