@veritree/services 2.56.0 → 2.58.0

package/index.js

@@ -41,6 +41,7 @@ import { Organizations } from './src/endpoints/organizations';
 import { Tasks } from './src/endpoints/tasks';
 import { Geometries } from './src/endpoints/geometries';
 import { Password } from './src/endpoints/password';
+import { TreeCodes } from './src/endpoints/tree-codes';
 
 export {
   BulkUploads,
@@ -86,4 +87,5 @@ export {
   Tasks,
   Geometries,
   Password,
+  TreeCodes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veritree/services",
-  "version": "2.56.0",
+  "version": "2.58.0",
   "description": "A collection of javascript functions/services to talk to veritree API",
   "type": "module",
   "main": "index.js",

package/src/endpoints/tree-codes.js

@@ -0,0 +1,95 @@
+import Api from "../helpers/api";
+
+class TreeCodesApi extends Api {
+  constructor(resource) {
+    super(resource);
+    this.resource = "tree-codes";
+  }
+
+  /**
+   * @private
+   * Constructs the URL for fetching items (campaigns, recipes, etc.) associated with a specific organization, sponsor, or reseller.
+   *
+   * @param {string} orgType - The shortened identifier for the organization type (o, s, r).
+   * @param {string} orgPublicId - The public identifier of the organization.
+   * @param {string} item - The specific item (campaigns, recipes, etc.) to fetch.
+   * @param {Object} params - Additional parameters for the API request.
+   * @returns {string} The constructed URL.
+   */
+  _constructFetchUrl(orgType, orgPublicId, item, params) {
+    return `${this.baseUrl}/${orgType}/${orgPublicId}/${
+      this.resource
+    }/${item}${this.getUrlParams(params)}`;
+  }
+
+  /**
+   * @param {string} orgType - Shortened organization type code (o, s, or r).
+   * @param {string} orgPublicId - Public ID of the organization.
+   * @param {object} params - Optional query parameters.
+   * @returns {object} - An object with a method 'all' that, when called, fetches all campaign data.
+   */
+  campaigns(orgType, orgPublicId, params) {
+    const url = this._constructFetchUrl(
+      orgType,
+      orgPublicId,
+      "campaigns",
+      params
+    );
+
+    /**
+     * Fetches campaign data
+     */
+    const all = async () => {
+      return await this.get(url);
+    }
+
+    const create = async (data) => {
+      return await this.post(url, data);
+    }
+
+    return {
+      all,
+      create
+    };
+  }
+
+  /**
+   * @param {string} orgType - The shortened identifier for the organization type (o, s, r).
+   * @param {string} orgPublicId - The public identifier of the organization.
+   * @param {Object} params - Additional parameters for the API request.
+   * @returns {Object} An object with a method 'all' to initiate the API request and retrieve recipes based on the provided parameters.
+   */
+  recipes(orgType, orgPublicId, params) {
+    const url = this._constructFetchUrl(
+      orgType,
+      orgPublicId,
+      "recipes",
+      params
+    );
+
+    /**
+     * Fetches recipes data
+     */
+    const all = async () => {
+      return await this.get(url);
+    }
+
+    return {
+      all,
+    };
+  }
+
+  ingredients(recipePubliId, params) {
+    const url = `${this.getUrl()}/recipes/${recipePubliId}/ingredients${this.getUrlParams(params)}`;
+
+    const all = async () => {
+      return await this.get(url);
+    }
+
+    return {
+      all,
+    };
+  }
+}
+
+export const TreeCodes = new TreeCodesApi();