Get Categories Aggregation

Author: GTFalcao

components/dataforseo/actions/get-categories-aggregation/get-categories-aggregation.mjs

@@ -0,0 +1,79 @@
+import { parseObjectEntries } from "../../common/utils.mjs";
+import dataforseo from "../../dataforseo.app.mjs";
+
+export default {
+  key: "dataforseo-get-categories-aggregation",
+  name: "Get Categories Aggregation",
+  description:
+    "Get information about groups of related categories and the number of entities in each category. [See the documentation](https://docs.dataforseo.com/v3/business_data/business_listings/categories_aggregation/live/)",
+  version: "0.0.1",
+  type: "action",
+  methods: {
+    getCategoriesAggregation(args = {}) {
+      return this._makeRequest({
+        path: "/business_data/business_listings/categories_aggregation/live",
+        method: "post",
+        ...args,
+      });
+    },
+  },
+  props: {
+    dataforseo,
+    categories: {
+      propDefinition: [
+        dataforseo,
+        "businessCategories",
+      ],
+    },
+    description: {
+      propDefinition: [
+        dataforseo,
+        "description",
+      ],
+    },
+    title: {
+      propDefinition: [
+        dataforseo,
+        "title",
+      ],
+    },
+    locationCoordinate: {
+      propDefinition: [
+        dataforseo,
+        "locationCoordinate",
+      ],
+      optional: true,
+    },
+    tag: {
+      propDefinition: [
+        dataforseo,
+        "tag",
+      ],
+    },
+    additionalOptions: {
+      propDefinition: [
+        dataforseo,
+        "additionalOptions",
+      ],
+      description:
+        "Additional parameters to send in the request. [See the documentation](https://docs.dataforseo.com/v3/business_data/business_listings/categories_aggregation/live/) for all available parameters. Values will be parsed as JSON where applicable.",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.getCategoriesAggregation({
+      $,
+      data: [
+        {
+          categories: this.categories,
+          description: this.description,
+          title: this.title,
+          location_coordinate: this.locationCoordinate,
+          tag: this.tag,
+          ...parseObjectEntries(this.additionalOptions),
+        },
+      ],
+    });
+    $.export("$summary", "Successfully retrieved categories aggregation");
+    return response;
+  },
+};

components/dataforseo/actions/search-business-listings/search-business-listings.mjs

@@ -20,30 +20,28 @@ export default {
   props: {
     dataforseo,
     categories: {
-      type: "string[]",
-      label: "Business Categories",
-      description: "Up to 10 categories used to search for business listings.",
-      optional: true,
+      propDefinition: [
+        dataforseo,
+        "businessCategories",
+      ],
     },
     description: {
-      type: "string",
-      label: "Description",
-      description:
-        "Description of the business entity for which the results are collected",
-      optional: true,
+      propDefinition: [
+        dataforseo,
+        "description",
+      ],
     },
     title: {
-      type: "string",
-      label: "Title",
-      description:
-        "Title of the business entity for which the results are collected",
-      optional: true,
+      propDefinition: [
+        dataforseo,
+        "title",
+      ],
     },
     locationCoordinate: {
-      type: "string",
-      label: "Location Coordinates",
-      description:
-        "The location to search, in the format `latitude,longitude,radius` where radius is specified in kilometers. Example: `53.476225,-2.243572,200`",
+      propDefinition: [
+        dataforseo,
+        "locationCoordinate",
+      ],
       optional: true,
     },
     tag: {

components/dataforseo/dataforseo.app.mjs

@@ -23,7 +23,8 @@ export default {
     locationCoordinate: {
       type: "string",
       label: "Location Coordinate",
-      description: "The coordinate of the target location. It should be specified in the “latitude,longitude,radius” format, i.e.: `53.476225,-2.243572,200`",
+      description:
+        "The location to search, in the format `latitude,longitude,radius` where radius is specified in kilometers. Example: `53.476225,-2.243572,200`",
     },
     targetType: {
       type: "string",